Authentication

Log in

POST/api/auth/login

Authenticates a user with a username and password. Users with two-factor authentication receive a short-lived partial token to complete sign-in.

Request body

Name	Type	Description
passwordrequired	string	Umami password.
usernamerequired	string	Umami username.

Example request

{
  "password": "string",
  "username": "string"
}

Responses

200Authenticated successfully.

Name	Type	Description
anyOf	anyOf

200 example

{
  "partialToken": "string",
  "requiresTwoFactor": true
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

503Service unavailable.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

503 example

{
  "error": {
    "code": "service-unavailable",
    "message": "Service unavailable.",
    "status": 503
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/auth/login' \
  -H 'Content-Type: application/json' \
  -d '{
  "password": "string",
  "username": "string"
}'

PreviousGet subscription details NextLog out