Activate a pending TOTP credential.

POST

/api/account/totp/activate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/account/totp/activate \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "credential_id": "example", "code": "example" }'

Verifies the first TOTP code, activates the credential, and returns newly generated backup codes when TOTP login or TOTP account linking is enabled.

Authorizations

• accountSessionCookie

Request Body ^required

Media type application/json

object

credential_id

required

string

code

required

string

/^(?:[0-9]{6}|[0-9]{8})$/

Example ^generated

{
  "credential_id": "example",
  "code": "example"
}

Responses

200

Account Page TOTP activation response.

Media type application/json

object

ok

required

boolean

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

backup_codes

required

One-time backup codes returned only immediately after generation.

Array<string>

Example

{
  "credential": {
    "algorithm": "SHA1",
    "digits": 6,
    "status": "pending"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}