Skip to main content
POST
Start Authenticator App Enrollment

Authorizations

Authorization
string
header
required

Use a short-lived token obtained from the Server API's Track Action endpoint. The token is valid for 10 minutes and should be passed in the Authorization header as 'Bearer {token}'.

Response

OK

userAuthenticatorId
string

The ID of the TOTP authenticator which has been created but not yet verified.

userId
string
uri
string

A URI which can be converted into a QR code and scanned by an authenticator app.

secret
string

A secret which can be manually entered into an authenticator app. Typically presented as a backup option if the user is unable to scan the QR code.