Skip to content

API-key login

POST
/v1/login
curl --request POST \
--url https://example.com/v1/login

Exchanges an API key for a full JWT. Send the key as Authorization: Bearer <api-key>; no request body. There is no second factor on this path.

Full token issued

Media typeapplication/json

Returned by the API-key login and the 2FA-exchange step with a full token, and by password login (no TOTP enrolled) with a bootstrap token.

object
success
required
boolean
token
required

The JWT to send as Authorization: Bearer <jwt>.

string
type
required

full grants every endpoint the user is authorized for; bootstrap only opens the TOTP-enrollment endpoints.

string
Allowed values: full bootstrap
Example
{
"type": "full"
}

Error response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
type

Problem type slug URI

string
title
string
status
integer
detail
string
key
additional properties
any
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}