---
updatedAt: 2026-06-12T14:47:10.000Z
agentTools:
  projectIndex: https://docs.formant.io/llms.txt
---

# Login

Log into your Formant organization.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "LoginRequest": {
        "properties": {
          "email": {
            "format": "email",
            "type": "string",
            "description": "Enter the email address associated with your Formant account."
          },
          "password": {
            "type": "string",
            "description": "Enter the password associated with your Formant account."
          },
          "tokenExpirationSeconds": {
            "type": "integer",
            "format": "int64",
            "minimum": 60,
            "maximum": 604800,
            "description": "How long you want this authentication token to be valid (default 1 hour)."
          }
        },
        "type": "object",
        "required": [
          "email",
          "password"
        ]
      },
      "Authentication": {
        "properties": {
          "accessToken": {
            "type": "string"
          },
          "organizationId": {
            "format": "uuid",
            "type": "string"
          },
          "userId": {
            "format": "uuid",
            "type": "string"
          },
          "refreshToken": {
            "type": "string"
          },
          "isSuperuser": {
            "type": "boolean"
          }
        },
        "type": "object",
        "required": [
          "accessToken",
          "organizationId",
          "userId"
        ]
      },
      "Challenge": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "new-password-required"
            ]
          },
          "session": {
            "type": "string"
          },
          "userId": {
            "format": "uuid",
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        },
        "type": "object",
        "required": [
          "type",
          "session",
          "userId",
          "email"
        ]
      },
      "LoginResult": {
        "properties": {
          "authentication": {
            "$ref": "#/components/schemas/Authentication"
          },
          "challenge": {
            "$ref": "#/components/schemas/Challenge"
          },
          "isExistingUser": {
            "type": "boolean"
          }
        },
        "type": "object",
        "required": [
          "authentication"
        ]
      }
    }
  },
  "info": {
    "title": "Formant admin-api",
    "version": "1.357.8"
  },
  "openapi": "3.0.0",
  "paths": {
    "/auth/login": {
      "post": {
        "operationId": "AuthController.login",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LoginRequest"
              }
            }
          },
          "description": "LoginRequest",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LoginResult"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "Login",
        "tags": [
          "Auth"
        ],
        "description": "Log into your Formant organization."
      }
    }
  },
  "servers": [
    {
      "url": "https://api.formant.io/v1/admin"
    }
  ]
}
```