Skip to main content
POST
/
api
/
v1
/
gate
/
{project_id}
/
auth
/
login
Login
curl --request POST \
  --url https://org-api.hexoforge.dev/api/v1/gate/{project_id}/auth/login \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "<string>",
  "password": "<string>"
}
'
{
  "last_login_method": {}
}

Documentation Index

Fetch the complete documentation index at: https://orchestrator-docs.hexoforge.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authenticates a user with email and password. Requires X-API-Key. If the user has TOTP enabled, tokens are not returned until you call Login TOTP.

​
Request body

​
email
string
required
Valid email.
​
password
string
required
Max 128 characters.

​
Response

{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "refresh_token": "dGhpcyBpcyBhIHJlZnJlc2g...",
  "token_type": "bearer",
  "expires_in": 900,
  "requires_totp": false,
  "login_ticket": null,
  "last_login_method": "email"
}
​
last_login_method
string | null
Reflects the previous authentication method (for example email, email_totp). Use for “Last signed in with…” hints. null on the user’s first login.

​
Status codes

CodeMeaning
200Success or TOTP step required
401Invalid email or password
403Account disabled, email not verified, IP block, or firewall deny
429Rate limited