Sign in
Environments

Get environment passkey settings

Changed on

Retrieve passkey policy for the current environment.

<div> <code>read:passkey</code> </div>
get/api/v1/passkey

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/passkey
  • Auth: HTTP bearer

Response

Passkey settings successfully retrieved.

messagestring
codestring
enabledboolean

Whether passkeys are enabled for this environment (policy is not off).

policy'off' | 'optional' | 'mandatory'

Environment passkey policy. off disables passkeys; optional enables passkeys and allows users to skip passkey setup after password sign-in; mandatory requires passkey setup after first password sign-in.

Example response

{
  "message": "Success",
  "code": "OK"
}

Changes