Create Recovery Challenge

Edit online

Starts a user recovery session and returns a challenge that the user must sign to verify their identity. This challenge is used to complete the account recovery flow.

HTTP request

POST/auth/recover/user/init

Request body

Field	Type	Required	Description
`username`	string	Yes	Minimum length: 1.
`verificationCode`	string	Yes	Minimum length: 1.
`orgId`	string	Yes	Minimum length: 1.
`credentialId`	string	Yes	Minimum length: 1.

curl --request POST \
  --url https://api.digitalassets.ibm.com/auth/recover/user/init \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "verificationCode": "<string>",
  "orgId": "<string>",
  "credentialId": "<string>"
}
'

Response

200: Success

Returns details about the newly created credential.

Example response:

{
  "user": {
    "id": "<string>",
    "displayName": "<string>",
    "name": "<string>"
  },
  "temporaryAuthenticationToken": "<string>",
  "challenge": "<string>",
  "supportedCredentialKinds": {
    "firstFactor": [
      "Fido2"
    ],
    "secondFactor": [
      "Fido2"
    ]
  },
  "authenticatorSelection": {
    "residentKey": "required",
    "requireResidentKey": true,
    "userVerification": "required",
    "authenticatorAttachment": "platform"
  },
  "attestation": "none",
  "pubKeyCredParams": [
    {
      "type": "public-key",
      "alg": 123
    }
  ],
  "excludeCredentials": [
    {
      "type": "public-key",
      "id": "cr-6uunn-bm6ja-f6rmod5kqrk5rbel"
    }
  ],
  "otpUrl": "<string>",
  "allowedRecoveryCredentials": [
    {
      "id": "<string>",
      "encryptedRecoveryKey": "<string>"
    }
  ],
  "rp": {
    "id": "<string>",
    "name": "<string>"
  }
}