Skip to content

Sign in to the console: email, password and a code; sets the console's own session cookie for twelve hours.

POST
/api/admin/session
curl --request POST \
--url https://example.com/api/admin/session \
--header 'Content-Type: application/json' \
--data '{ "email": "example", "password": "example", "code": "example", "recoveryCode": "example" }'
Media typeapplication/json
object
email
required
string
password
required
string
code
null | string
recoveryCode
null | string

Example generated

{
"email": "example",
"password": "example",
"code": "example",
"recoveryCode": "example"
}

OK

Media typeapplication/json
object
accountId
required
string format: uuid
displayName
required
string
email
required
null | string
role
required
string
permissions
required
Array<string>
openUntil
required
string format: date-time
secureUntil
required
null | string format: date-time

Example generated

{
"accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"displayName": "example",
"email": "example",
"role": "example",
"permissions": [
"example"
],
"openUntil": "2026-04-15T12:00:00Z",
"secureUntil": "2026-04-15T12:00:00Z"
}