Create Recovery Challenge
Starts a user recovery session, returning a challenge that will be used to verify the user’s identity.
Authentication
No authentication required.Required Permissions
No authentication required.Body
Username/identifier of the user to recover.
1Recovery verification code sent to the user by email.
1Identifier of the recovery credential to use.
1Organization id.
1 - 64^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"or-30tnh-itmjs-s235s5ontr3r23h2"
Account id.
1 - 64^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"acct-24hka-dhili-9hgvdlvr1ohpibp4"
Response
Success
JWT used to identify the registration session when calling Complete User Registration.
Challenge to be signed by the credential being registered.
Credential kinds that can be used to register the user.
Identifies the information needed to verify the user's signing certificate; can be one of the following:
- none: indicates no attestation data is required
- indirect: indicates the attestation data should be given, but that it can be generated using an Anonymization CA
- direct: indicates the attestation data must be given and should be generated by the authenticator
- enterprise: indicates the attestation data should include information to uniquely identify the user's device
none, indirect, direct, enterprise Public key credential parameters supported for the registration.
Credentials to exclude from the registration (already registered for the user).
URL to provision a TOTP credential, when applicable.
Deprecated. Should not be used.