API
The account API, with the shape of every request and response.
On this page
The routes and schemas below are generated from the route table in the API contract. They cover the account surface (/v1/me), which a signed-in person's browser and a personal access token call, and the sign-in routes under /auth/v1 that identity's own pages call. An application that signs people in uses the OIDC endpoints and the SDK instead: see Build with identity. A route marked as a placeholder has no schema yet.
GET/v1/me/activity/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
events | array | required | |
events[] | object | required | |
events[].at | string | required | |
events[].ip | string | null | required | |
events[].kind | string | required | |
events[].label | string | required | |
events[].relation | string | required | |
events[].seq | string | required | |
events[].target_kind | string | null | required | |
next_before | string | null | required |
POST/v1/me/agents/:id/revoke/v1/me#
Request
No body.
Response
No body.
GET/v1/me/agents/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
agents | array | required | |
agents[] | object | required | |
agents[].created_at | string | required | |
agents[].id | string | required | |
agents[].last_used_at | string | null | required | |
agents[].may_delegate | boolean | required | |
agents[].name | string | required | |
agents[].status | string | required | |
agents[].tenant_label | string | required |
DELETE/v1/me/avatar/v1/me#
Request
No body.
Response
No body.
PUT/v1/me/avatar/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
picture | string | null | required |
GET/v1/me/security/checkup/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
items | array | required | |
items[] | object | required | |
items[].action | anyOf | required | |
items[].action#1 | object | required | |
items[].action#1.href | string | required | |
items[].action#1.kind | string | required | const: link |
items[].action#2 | null | required | |
items[].detail | string | required | |
items[].earned | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
items[].id | string | required | enum: passkey, backup, password_breach, recovery_codes, sessions, second_email |
items[].status | string | required | enum: ok, warn, risk |
items[].title | string | required | |
items[].weight | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
level | string | required | enum: strong, fair, weak |
score | integer | required | minimum: 0; maximum: 100 |
GET/v1/me/clients/:id/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
client_id | string | required | |
created_at | string | required | |
id | string | required | |
kind | string | required | |
name | string | required | |
public | boolean | required | |
redirect_uris | array<string> | required | |
require_dpop | boolean | required | |
scopes | array<string> | required | |
status | string | required |
POST/v1/me/clients/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
kind | string | required | enum: spa, native |
name | string | required | minLength: 1 |
redirect_uris | array<string> | required | |
scopes | array<string> | optional |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
client_id | string | required | |
created_at | string | required | |
id | string | required | |
kind | string | required | |
name | string | required | |
public | boolean | required | |
redirect_uris | array<string> | required | |
require_dpop | boolean | required | |
scopes | array<string> | required | |
status | string | required |
PATCH/v1/me/clients/:id/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | optional | minLength: 1 |
redirect_uris | array<string> | optional | |
scopes | array<string> | optional |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
client_id | string | required | |
created_at | string | required | |
id | string | required | |
kind | string | required | |
name | string | required | |
public | boolean | required | |
redirect_uris | array<string> | required | |
require_dpop | boolean | required | |
scopes | array<string> | required | |
status | string | required |
POST/v1/me/clients/:id/enable/v1/me#
Request
No body.
Response
No body.
POST/v1/me/clients/:id/suspend/v1/me#
Request
No body.
Response
No body.
GET/v1/me/clients/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
can_create | boolean | required | |
clients | array | required | |
clients[] | object | required | |
clients[].client_id | string | required | |
clients[].created_at | string | required | |
clients[].id | string | required | |
clients[].kind | string | required | |
clients[].name | string | required | |
clients[].public | boolean | required | |
clients[].redirect_uris | array<string> | required | |
clients[].require_dpop | boolean | required | |
clients[].scopes | array<string> | required | |
clients[].status | string | required | |
has_personal_workspace | boolean | required | |
rules | object | required | |
rules.kinds | array<string> | required | |
rules.max_clients | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
rules.max_redirect_uris | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
rules.public_clients_only | boolean | required | |
rules.require_dpop | boolean | required | |
rules.scopes | array<string> | required |
DELETE/v1/me/consents/:clientId/v1/me#
Request
No body.
Response
No body.
GET/v1/me/consents/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
consents | array | required | |
consents[] | object | required | |
consents[].client_id | string | required | |
consents[].granted_at | string | required | |
consents[].name | string | required | |
consents[].scopes | array<string> | required |
GET/v1/me/data-exports/:id/download/v1/me#
Request
No body.
Response
No body.
POST/v1/me/data-exports/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | required | |
status | string | required |
GET/v1/me/data-exports/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
exports | array | required | |
exports[] | object | required | |
exports[].downloadable | boolean | required | |
exports[].expires_at | string | null | required | |
exports[].has_csv | boolean | required | |
exports[].id | string | required | |
exports[].ready_at | string | null | required | |
exports[].requested_at | string | required | |
exports[].status | string | required |
POST/v1/me/deactivate/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
confirm | string | required | minLength: 1 |
Response
No body.
POST/v1/me/delete/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
confirm | string | required | minLength: 1 |
Response
No body.
DELETE/v1/me/devices/:id/v1/me#
Request
No body.
Response
No body.
PATCH/v1/me/devices/:id/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | null | required |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
first_seen_at | string | required | |
id | string | required | |
last_seen_at | string | required | |
name | string | null | required | |
trust | string | required | |
trusted_at | string | null | required |
PUT/v1/me/devices/:id/trust/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
trust | string | required |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
first_seen_at | string | required | |
id | string | required | |
last_seen_at | string | required | |
name | string | null | required | |
trust | string | required | |
trusted_at | string | null | required |
GET/v1/me/devices/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
devices | array | required | |
devices[] | object | required | |
devices[].first_seen_at | string | required | |
devices[].id | string | required | |
devices[].last_seen_at | string | required | |
devices[].name | string | null | required | |
devices[].trust | string | required | |
devices[].trusted_at | string | null | required |
POST/v1/me/devices/untrust-all/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
changed | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
POST/v1/me/emails/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
address | string | required | minLength: 1; maxLength: 320 |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | required |
POST/v1/me/emails/:id/primary/v1/me#
Request
No body.
Response
No body.
DELETE/v1/me/emails/:id/v1/me#
Request
No body.
Response
No body.
POST/v1/me/emails/:id/resend/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | required |
POST/v1/me/emails/verify/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
secret | string | required | minLength: 1 |
Response
No body.
GET/v1/me/emails/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
emails | array | required | |
emails[] | object | required | |
emails[].address | string | required | |
emails[].id | string | required | |
emails[].primary | boolean | required | |
emails[].verification_expires_at | string | null | required | |
emails[].verified | boolean | required |
POST/v1/me/federation/:id/link/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
return_to | string | optional | enum: /account/security, /account/sessions, /account/tokens, /account/privacy, /account/developer, /account/profile, /account/organizations |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
label | string | required | |
redirect_to | string | required |
DELETE/v1/me/federation/:id/v1/me#
Request
No body.
Response
No body.
POST/v1/me/first-factor/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
current_password | string | required | minLength: 1 |
kind | string | required | enum: totp, passkey |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
challenge_id | string | optional | |
options | object | optional | |
otpauth_uri | string | optional | |
secret_base32 | string | optional |
GET/v1/me/invitation/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
ready | boolean | required | const: true |
POST/v1/me/invitation/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
confirm | string | optional | |
password | string | optional | |
secret | string | required | minLength: 1 |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
joined | boolean | required | const: true |
POST/v1/me/invitations/:id/accept/v1/me#
Request
No body.
Response
No body.
POST/v1/me/invitations/:id/decline/v1/me#
Request
No body.
Response
No body.
GET/v1/me/invitations/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
invitations | array | required | |
invitations[] | object | required | |
invitations[].expires_at | string | required | |
invitations[].guest_ttl_s | anyOf | required | |
invitations[].guest_ttl_s#1 | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
invitations[].guest_ttl_s#2 | null | required | |
invitations[].id | string | required | |
invitations[].kind | string | required | enum: member, guest |
invitations[].organization | string | required | |
invitations[].role | string | null | required | |
invitations[].sponsor | string | null | required |
POST/v1/me/merge/confirm/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
code | string | optional | |
handle | string | required | minLength: 1 |
password | string | required |
Response
No body.
POST/v1/me/merge/lookup/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
email | string | required | minLength: 1; maxLength: 320 |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
handle | string | required |
POST/v1/me/merge/passkey/options/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
handle | string | required | minLength: 1 |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
binding | string | required | |
challenge_id | string | required | |
options | object | required |
POST/v1/me/merge/passkey/verify/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
binding | string | required | minLength: 1 |
challenge_id | string | required | minLength: 1 |
credential | object | required | |
handle | string | required | minLength: 1 |
Response
No body.
GET/v1/me/notifications/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
marketing_emails | boolean | required | |
product_updates | boolean | required |
PUT/v1/me/notifications/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
marketing_emails | boolean | required | |
product_updates | boolean | required |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
marketing_emails | boolean | required | |
product_updates | boolean | required |
POST/v1/me/organizations/:tenantId/leave/v1/me#
Request
No body.
Response
No body.
POST/v1/me/organizations/:tenantId/upgrade/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
kind | string | required | const: customer |
tenant_id | string | required |
GET/v1/me/organizations/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
organizations | array | required | |
organizations[] | object | required | |
organizations[].capture_domain | string | null | required | |
organizations[].expires_at | string | null | required | |
organizations[].joined_at | string | null | required | |
organizations[].label | string | required | |
organizations[].leave_blocked | anyOf | required | |
organizations[].leave_blocked#1 | string | required | enum: last_platform_admin, personal, managed |
organizations[].leave_blocked#2 | null | required | |
organizations[].managed | boolean | required | |
organizations[].membership_kind | string | required | enum: owner, member, guest |
organizations[].parent_label | string | null | required | |
organizations[].sponsor_label | string | null | required | |
organizations[].status | string | required | |
organizations[].tenant_id | string | required | |
organizations[].tenant_kind | string | required | enum: internal, customer, personal |
GET/v1/me/overview/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
activity | anyOf | required | |
activity#1 | object | required | |
activity#1.events | array | required | |
activity#1.events[] | object | required | |
activity#1.events[].at | string | required | |
activity#1.events[].ip | string | null | required | |
activity#1.events[].kind | string | required | |
activity#1.events[].label | string | required | |
activity#1.events[].seq | string | required | |
activity#1.next_before | string | null | required | |
activity#2 | null | required | |
checkup | anyOf | required | |
checkup#1 | object | required | |
checkup#1.items | array | required | |
checkup#1.items[] | object | required | |
checkup#1.items[].action | anyOf | required | |
checkup#1.items[].action#1 | object | required | |
checkup#1.items[].action#1.href | string | required | |
checkup#1.items[].action#1.kind | string | required | const: link |
checkup#1.items[].action#2 | null | required | |
checkup#1.items[].detail | string | required | |
checkup#1.items[].earned | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
checkup#1.items[].id | string | required | enum: passkey, backup, password_breach, recovery_codes, sessions, second_email |
checkup#1.items[].status | string | required | enum: ok, warn, risk |
checkup#1.items[].title | string | required | |
checkup#1.items[].weight | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
checkup#1.level | string | required | enum: strong, fair, weak |
checkup#1.score | integer | required | minimum: 0; maximum: 100 |
checkup#2 | null | required | |
consents | anyOf | required | |
consents#1 | array | required | |
consents#1[] | object | required | |
consents#1[].client_id | string | required | |
consents#1[].granted_at | string | required | |
consents#1[].name | string | required | |
consents#1[].scopes | array<string> | required | |
consents#2 | null | required | |
expiring_tokens | anyOf | required | |
expiring_tokens#1 | array | required | |
expiring_tokens#1[] | object | required | |
expiring_tokens#1[].expires_at | string | required | |
expiring_tokens#1[].name | string | required | |
expiring_tokens#2 | null | required | |
organizations | anyOf | required | |
organizations#1 | array | required | |
organizations#1[] | object | required | |
organizations#1[].capture_domain | string | null | required | |
organizations#1[].expires_at | string | null | required | |
organizations#1[].label | string | required | |
organizations#1[].managed | boolean | required | |
organizations#1[].membership_kind | string | required | enum: owner, member, guest |
organizations#1[].parent_label | string | null | required | |
organizations#1[].sponsor_label | string | null | required | |
organizations#1[].status | string | required | |
organizations#1[].tenant_id | string | required | |
organizations#1[].tenant_kind | string | required | enum: internal, customer, personal |
organizations#2 | null | required | |
sessions | anyOf | required | |
sessions#1 | array | required | |
sessions#1[] | object | required | |
sessions#1[].city | string | null | required | |
sessions#1[].country | string | null | required | |
sessions#1[].current | boolean | required | |
sessions#1[].id | string | required | |
sessions#1[].label | string | null | required | |
sessions#1[].last_seen_at | string | required | |
sessions#2 | null | required |
POST/v1/me/passkeys/register/options/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
challenge_id | string | required | |
options | object | required |
POST/v1/me/passkeys/register/verify/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
challenge_id | string | required | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ |
label | string | optional | |
response | object | required |
Response
| Field | Type | Required | Constraints |
|---|
DELETE/v1/me/passkeys/:id/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
signal | object | required | |
signal.all_accepted_credential_ids | array<string> | required | |
signal.rp_id | string | required | |
signal.user | object | required | |
signal.user.display_name | string | required | |
signal.user.name | string | required | |
signal.user_id | string | required |
PATCH/v1/me/passkeys/:id/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
label | string | required |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
created_at | string | required | |
id | string | required | |
label | string | null | required | |
last_used_at | string | null | required |
PUT/v1/me/password/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
current_password | string | required | minLength: 1 |
new_password | string | required | minLength: 1 |
revoke_api_tokens | boolean | optional |
Response
No body.
GET/v1/me/password/policy/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
breach_check | boolean | required | |
max_input_length | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
max_length | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
max_repeated_unit | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
min_distinct_characters | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
min_length | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
normalization | string | required |
POST/v1/me/password/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
new_password | string | required | minLength: 1 |
Response
| Field | Type | Required | Constraints |
|---|
GET/v1/me/profile/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
bio | string | null | required | |
created_at | string | required | |
display_name | string | required | |
email | string | null | required | |
email_verified | boolean | required | |
locale | string | null | required | |
managed_by | string | null | required | |
picture | string | null | required | |
session | object | required | |
session.aal | number | required | |
session.amr | array<string> | required | |
session.id | string | required | |
session.tenant_id | string | null | required | |
session.via | string | required | enum: cookie, token |
sub | string | required | |
tz | string | null | required | |
updated_at | string | required | |
username | string | null | required |
PATCH/v1/me/profile/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
bio | string | null | optional | |
display_name | string | optional | |
locale | string | optional | |
tz | string | optional | |
username | string | null | optional |
Response
No body.
POST/v1/me/recovery/cancel/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
cancelled | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
POST/v1/me/recovery-codes/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
recovery_codes | array<string> | required |
POST/v1/me/security/second-step/email-code/disable/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
enabled | boolean | required |
POST/v1/me/security/second-step/email-code/enable/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
enabled | boolean | required |
POST/v1/me/security/second-step/password/disable/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
enabled | boolean | required |
POST/v1/me/security/second-step/password/enable/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
enabled | boolean | required |
GET/v1/me/security/second-step/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
email_code | object | required | |
email_code.available | boolean | required | |
email_code.enabled | boolean | required | |
password | object | required | |
password.available | boolean | required | |
password.enabled | boolean | required |
GET/v1/me/security/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
captured_by_domain | string | null | required | |
first_factor_bootstrap | boolean | required | |
first_factor_bootstrap_after | string | null | optional | |
has_password | boolean | required | |
legacy_recovery_codes_lost | boolean | required | |
linked_accounts | object | optional | |
linked_accounts.available | array | required | |
linked_accounts.available[] | object | required | |
linked_accounts.available[].id | string | required | |
linked_accounts.available[].label | string | required | |
linked_accounts.linked | array | required | |
linked_accounts.linked[] | object | required | |
linked_accounts.linked[].email | string | required | |
linked_accounts.linked[].id | string | required | |
linked_accounts.linked[].label | string | required | |
linked_accounts.linked[].last_used_at | string | null | required | |
linked_accounts.linked[].linked_at | string | required | |
linked_accounts.linked[].provider_id | string | null | required | |
linked_accounts.sso_available | array | optional | |
linked_accounts.sso_available[] | object | required | |
linked_accounts.sso_available[].id | string | required | |
linked_accounts.sso_available[].label | string | required | |
linked_accounts.sso_available[].organization | string | required | |
merge_enabled | boolean | required | |
passkeys | array | required | |
passkeys[] | object | required | |
passkeys[].created_at | string | required | |
passkeys[].id | string | required | |
passkeys[].label | string | null | required | |
passkeys[].last_used_at | string | null | required | |
recovery_codes_remaining | anyOf | required | |
recovery_codes_remaining#1 | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
recovery_codes_remaining#2 | null | required | |
recovery_pending | anyOf | required | |
recovery_pending#1 | object | required | |
recovery_pending#1.hold_until | string | null | required | |
recovery_pending#2 | null | required | |
second_step | object | required | |
second_step.email_code | object | required | |
second_step.email_code.available | boolean | required | |
second_step.email_code.enabled | boolean | required | |
second_step.password | object | required | |
second_step.password.available | boolean | required | |
second_step.password.enabled | boolean | required | |
signal | object | required | |
signal.all_accepted_credential_ids | array<string> | required | |
signal.rp_id | string | required | |
signal.user | object | required | |
signal.user.display_name | string | required | |
signal.user.name | string | required | |
signal.user_id | string | required | |
totp | object | required | |
totp.enabled | boolean | required | |
totp.enabled_at | string | null | required | |
two_factor_required | boolean | required |
GET/v1/me/security-events/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
events | array | required | |
events[] | object | required | |
events[].at | string | required | |
events[].ip | string | null | required | |
events[].kind | string | required | |
events[].label | string | required | |
events[].read | boolean | required | |
events[].seq | string | required | |
events[].severity | string | required | enum: info, warn, risk |
last_read_seq | string | required | |
next_before | string | null | required | |
unread | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
POST/v1/me/security-events/read/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
up_to_seq | anyOf | required | |
up_to_seq#1 | string | required | pattern: ^[0-9]{1,19}$ |
up_to_seq#2 | integer | required | minimum: 0; maximum: 9007199254740991 |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
last_read_seq | string | required |
DELETE/v1/me/sessions/:id/v1/me#
Request
No body.
Response
No body.
GET/v1/me/session/status/v1/me#
Request
No body.
Response
No body.
GET/v1/me/sessions/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
sessions | array | required | |
sessions[] | object | required | |
sessions[].aal | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
sessions[].absolute_expires_at | string | required | |
sessions[].amr | array<string> | required | |
sessions[].city | string | null | required | |
sessions[].country | string | null | required | |
sessions[].created_at | string | required | |
sessions[].current | boolean | required | |
sessions[].device_id | string | null | required | |
sessions[].id | string | required | |
sessions[].idle_expires_at | string | required | |
sessions[].ip | string | null | required | |
sessions[].label | string | null | required | |
sessions[].last_seen_at | string | required | |
sessions[].method | string | null | required | |
sessions[].rp_clients | array | required | |
sessions[].rp_clients[] | object | required | |
sessions[].rp_clients[].client_id | string | required | |
sessions[].rp_clients[].name | string | required | |
sessions[].sso | anyOf | optional | |
sessions[].sso#1 | object | required | |
sessions[].sso#1.connection | string | null | required | |
sessions[].sso#1.tenants | array | required | |
sessions[].sso#1.tenants[] | object | required | |
sessions[].sso#1.tenants[].auth_time | string | required | |
sessions[].sso#1.tenants[].mfa | boolean | required | |
sessions[].sso#1.tenants[].tenant | string | required | |
sessions[].sso#2 | null | required |
POST/v1/me/sessions/revoke-all/v1/me#
Request
No body.
Response
No body.
GET/v1/me/shell/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
organizations | array | optional | |
organizations[] | object | required | |
organizations[].capture_domain | string | null | required | |
organizations[].expires_at | string | null | required | |
organizations[].joined_at | string | null | required | |
organizations[].label | string | required | |
organizations[].leave_blocked | anyOf | required | |
organizations[].leave_blocked#1 | string | required | enum: last_platform_admin, personal, managed |
organizations[].leave_blocked#2 | null | required | |
organizations[].managed | boolean | required | |
organizations[].membership_kind | string | required | enum: owner, member, guest |
organizations[].parent_label | string | null | required | |
organizations[].sponsor_label | string | null | required | |
organizations[].status | string | required | |
organizations[].tenant_id | string | required | |
organizations[].tenant_kind | string | required | enum: internal, customer, personal |
profile | object | required | |
profile.bio | string | null | required | |
profile.created_at | string | required | |
profile.display_name | string | required | |
profile.email | string | null | required | |
profile.email_verified | boolean | required | |
profile.locale | string | null | required | |
profile.managed_by | string | null | required | |
profile.picture | string | null | required | |
profile.session | object | required | |
profile.session.aal | number | required | |
profile.session.amr | array<string> | required | |
profile.session.id | string | required | |
profile.session.tenant_id | string | null | required | |
profile.session.via | string | required | enum: cookie, token |
profile.sub | string | required | |
profile.tz | string | null | required | |
profile.updated_at | string | required | |
profile.username | string | null | required | |
security_events | object | required | |
security_events.events | array | required | |
security_events.events[] | object | required | |
security_events.events[].at | string | required | |
security_events.events[].ip | string | null | required | |
security_events.events[].kind | string | required | |
security_events.events[].label | string | required | |
security_events.events[].read | boolean | required | |
security_events.events[].seq | string | required | |
security_events.events[].severity | string | required | enum: info, warn, risk |
security_events.last_read_seq | string | required | |
security_events.next_before | string | null | required | |
security_events.unread | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
POST/v1/me/sign-out/v1/me#
Request
No body.
Response
No body.
POST/v1/me/sso/:id/link/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
return_to | string | optional | enum: /account/security, /account/sessions, /account/tokens, /account/privacy, /account/developer, /account/profile, /account/organizations |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
label | string | required | |
redirect_to | string | required |
POST/v1/me/step-up/email/v1/me#
Request
| Field | Type | Required | Constraints |
|---|
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
resend_after_s | integer | required | minimum: 0; maximum: 9007199254740991 |
POST/v1/me/step-up/email/verify/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
code | string | required | minLength: 1 |
Response
No body.
POST/v1/me/step-up/federation/:id/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
return_to | string | optional | enum: /account/security, /account/sessions, /account/tokens, /account/privacy, /account/developer, /account/profile, /account/organizations |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
label | string | required | |
redirect_to | string | required |
POST/v1/me/step-up/passkey/options/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
challenge_id | string | required | |
options | object | required |
POST/v1/me/step-up/passkey/verify/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
challenge_id | string | required | minLength: 1; maxLength: 64 |
credential | object | required |
Response
No body.
POST/v1/me/step-up/password/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
password | string | required | minLength: 1 |
Response
No body.
POST/v1/me/step-up/totp/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
code | string | required | minLength: 1 |
Response
No body.
POST/v1/me/tokens/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
expires_in_days | anyOf | required | |
expires_in_days#1 | integer | required | minimum: 1; maximum: 365 |
expires_in_days#2 | null | required | |
ip_allowlist | anyOf | optional | |
ip_allowlist#1 | array<string> | required | |
ip_allowlist#2 | null | required | |
name | string | required | minLength: 1 |
scopes | array<string> | required | |
tenant_id | string | optional |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
created_at | string | required | |
expires_at | string | null | required | |
id | string | required | |
ip_allowlist | anyOf | required | |
ip_allowlist#1 | array<string> | required | |
ip_allowlist#2 | null | required | |
last_used_at | string | null | required | |
name | string | required | |
prefix | string | required | |
scopes | array<string> | required | |
status | string | required | |
tenant_id | string | null | required | |
token | string | required |
PATCH/v1/me/tokens/:id/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | required | minLength: 1 |
Response
No body.
DELETE/v1/me/tokens/:id/v1/me#
Request
No body.
Response
No body.
GET/v1/me/tokens/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
tokens | array | required | |
tokens[] | object | required | |
tokens[].created_at | string | required | |
tokens[].expires_at | string | null | required | |
tokens[].id | string | required | |
tokens[].ip_allowlist | anyOf | required | |
tokens[].ip_allowlist#1 | array<string> | required | |
tokens[].ip_allowlist#2 | null | required | |
tokens[].last_used_at | string | null | required | |
tokens[].name | string | required | |
tokens[].prefix | string | required | |
tokens[].scopes | array<string> | required | |
tokens[].status | string | required | |
tokens[].tenant_id | string | null | required |
POST/v1/me/tokens/revoke-all/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
revoked | integer | required | minimum: -9007199254740991; maximum: 9007199254740991 |
POST/v1/me/totp/begin/v1/me#
Request
No body.
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
otpauth_uri | string | required | |
secret_base32 | string | required |
POST/v1/me/totp/confirm/v1/me#
Request
| Field | Type | Required | Constraints |
|---|---|---|---|
code | string | required | minLength: 1 |
Response
| Field | Type | Required | Constraints |
|---|---|---|---|
recovery_codes | array<string> | optional |
DELETE/v1/me/totp/v1/me#
Request
No body.
Response
No body.