POST /auth/registration/init

Edit online

By using POST /auth/registration/init API, you can start a user registration session. It returns a challenge that will need to be signed by a passkey and used to perform the step of completing user registration.

Authentication

No authentication required.

Required Permissions

No permissions required.

Parameters

orgId: Minimum length: 1

username: Minimum length: 1

registrationCode: Minimum length: 1

Request body

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

Response

200: Success

{
  "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>",
  "rp": {
    "id": "<string>",
    "name": "<string>"
  }
}