Get user security status REST API

GET

/api/user/security

const url = 'http://127.0.0.1:25737/api/user/security';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

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

curl --request GET \
  --url http://127.0.0.1:25737/api/user/security \
  --cookie hk_token=<hk_token>

Returns TOTP/passkey status.

Authorizations

cookieAuth

Responses

200

Security status

application/json

object

passkeys

Array<object>

object

created_at

string format: date-time

string format: uuid

name

string

updated_at

string format: date-time

password_login_enabled

boolean

recovery_codes_generated

boolean

recovery_codes_remaining

integer

social_identities

Array<object>

Safe linked-provider metadata. Immutable provider subjects are intentionally omitted.

object

last_used_at

string format: date-time

linked_at

required

string format: date-time

observed_email

string format: email

provider

required

string

Allowed values: google github microsoft

totp_enabled

boolean

totp_pending

boolean

Example

{
  "social_identities": [
    {
      "provider": "google"
    }
  ]
}