Register

Initiate creation of new user

POST /auth/register/init

First call to make in order to register the user

Headers

Name
Value

Content-Type

application/json

platform

android|ios|web

Body (Json)

{
    "email": string
}

Response

{
  "publicKeyCredentialCreationOptions": {
    "attestation": string,
    "authenticatorSelection": {
        "requireResidentKey": true,
        "residentKey": string,
        "userVerification": string
    },
    "challenge": string,
    "excludeCredentials": [
        {
            "type": string;
            "id": number;
        }
    ],
    "otpUrl": string,
    "pubKeyCredParams": {
        {
            "type": string;
            "alg": number;
        }
    ],
    "rp": {
        "id": string,
        "name": string
    },
    "supportedCredentialKinds": {
        "firstFactor": ["Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey"],
        "secondFactor": ["Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey"]
    },
    "temporaryAuthenticationToken": string,
    "user": {
        "displayName": string,
        "id": string,
        "name": string
    }
  },
  "temporaryAuthenticationToken": string
}

Complete creation of new user

POST /auth/register

Finish register workflow; use the result of the previous call /auth/register/init

circle-exclamation

Headers

Name
Value

Content-Type

application/json

x-join-key

api_token

triangle-exclamation

To create the recoveryCredential object you first need to create an object such as

Body (Json)

Response

returns 200 with empty body if register has been completed successfully

Last updated