Get passkey policy

Says whether your organization offers passkey sign-in, and whether it signs in through an SSO provider.

The option belongs to the organization resolved from your token; nothing in the request names another one. Passkeys and SSO exclude each other: passkeys cannot be turned on while an SSO provider is active, and an SSO provider cannot be configured while passkeys are on.

While passkeys are on, a person who has a passkey cannot sign in with a password (403 AUT-1019 on the password grant); everyone else signs in with password and second factor as before. Turning passkeys off lets everyone sign in with a password again; passkeys stay stored.

Read-only: nothing changes.

Failures:

• 404 — the application backing your organization’s login was not found.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET /v1/passkey/policy

Get passkey policy

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/passkey/policy \
  --header 'Authorization: Bearer <token>'

200

{
  "enabled": true,
  "ssoActive": false
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Resposta

200

application/json

OK

enabled · boolean

True when the organization offers passkey sign-in. While it is true, a person who has a passkey cannot sign in with a password.

Exemplo:

true

ssoActive · boolean

True when the organization signs in through an SSO provider. Passkeys cannot be turned on while it is true.

Exemplo:

false