Skip to content

Get account security settings

GET
/api/v1/auth/me/security
curl --request GET \
--url https://example.com/api/v1/auth/me/security \
--header 'Authorization: Bearer <token>'

Returns the account security settings. It requires a signed-in User with the account scope. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/me/security. Inputs: . Safe reads can use bounded retries.

Media typeapplication/json
object
has_recovery_key
required
boolean
identities
required
Array<object>

A linked OIDC identity. The subject is not returned.

object
issuer
required
string
provider

The configured provider whose issuer matches, if one still does.

string | null
legacy_recovery_codes
required

Unconsumed recovery codes from before the single recovery key.

integer format: int32
Examplegenerated
{
"has_recovery_key": true,
"identities": [
{
"issuer": "example",
"provider": "example"
}
],
"legacy_recovery_codes": 1
}

Too many requests

Media typeapplication/json
object
code
required
string
message
required
string
Examplegenerated
{
"code": "example",
"message": "example"
}