Skip to content

Sign in

POST
/api/v1/account/login
curl --request POST \
--url http://127.0.0.1:8080/api/v1/account/login \
--header 'Content-Type: application/json' \
--data '{ "login": "example", "password": "example" }'

Authenticates a local account and rotates the browser session. Uses the persisted local-mode user when authentication is disabled. Otherwise an authenticated browser session is required, except for the current account and sign-in. Modifying authenticated requests require the current X-CSRF-Token. Credentials and responses must not be cached.

Media typeapplication/json
object
login
required
string
password
required
string
Examplegenerated
{
"login": "example",
"password": "example"
}

Operation completed.

Media typeapplication/json
object
csrf_token
required
string
user
required
object
display_name
required
string
id
required
string
instance_admin
required
boolean
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"csrf_token": "example",
"user": {
"display_name": "example",
"id": "example",
"instance_admin": true
}
}

The credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

Stable account problem code; authentication, authority, validation or lifecycle conflict.

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}