Skip to content
Authrim

Create TOTP enrollment options.

POST
/api/account/totp/options
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/account/totp/options \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "label": "example" }'

Creates a pending TOTP credential, Base32 secret, and otpauth URI for the current user when TOTP login or TOTP account linking is enabled. Recent authentication is required.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
label
string
<= 100 characters
Example generated
{
  "label": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Account Page TOTP enrollment options response.

Media type application/json
object
credential
required
object
id
required
string
label
required
string
algorithm
required
string
Allowed values: SHA1 SHA256 SHA512
digits
required
integer
Allowed values: 6 8
period
required
integer
window
required
integer
status
required
string
Allowed values: pending active disabled
created_at
required
integer format: int64
activated_at
integer | null format: int64
last_used_at
integer | null format: int64
secret
required

Base32 TOTP secret shown once during enrollment.

string
otpauth_uri
required
string format: uri
profile
required
object
algorithm
required
string
digits
required
integer
period
required
integer
window
required
integer
Example 
{
  "credential": {
    "algorithm": "SHA1",
    "digits": 6,
    "status": "pending"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}