Create Recovery Challenge

POST /auth/recover/user/init

Starts a user recovery session, returning a challenge that will be used to verify the user's identity.

circle-info

Required Permissions

None

Request body

username *

String

Email address of the user

verificationCode *

String

The secret value that the user received in their recovery email

orgId *

String

ID of the target Org

credentialId *

String

The crdential ID of the user's recovery credential

Example

{
  "username": "[email protected]",
  "verificationCode": "1234-1234-1234-1234",
  "orgId": "or-34513-nip9c-8bppvgqgj28dbodrc",
  "credentialId": "GMkW0zlmcoMxI1OX0Z96LL_Mz7dgeu6vOH5_TOeGyNk"
}

Responses

circle-info

Success - an object containing the user's authentication options

Format:

Example

Last updated