securityStatus

GET

/api/v1/me/security

const url = 'https://example.com/api/v1/me/security';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/me/security

Security status. Requires an enrolled dashboard session.

Responses

200

Enrolled factors, passkeys, and policy state

application/json

object

data

required

object

relyingPartyId

required

string

userHandle

required

string

totpEnrolled

required

boolean

totpConfirmedAt

string format: date-time

passkeys

required

Array<object>

object

required

string format: uuid

name

required

string

credentialId

required

string

createdAt

required

string format: date-time

lastUsedAt

string format: date-time

recoveryCodesRemaining

required

integer

enrolled

required

boolean

passkeysAvailable

required

boolean

passkeysUnavailableReason

required

string

required

required

boolean

policy

required

string

Allowed values: none administrators all

authMethod

required

string

Allowed values: password totp passkey recovery_code demo

Example

{
  "data": {
    "policy": "none",
    "authMethod": "password"
  }
}

401

Authentication required