List current user's TOTP credentials.

GET

/api/account/totp

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/account/totp \
  --cookie authrim_session=<authrim_session>

Returns pending and active TOTP credentials plus backup-code count metadata.

Authorizations

• accountSessionCookie

Responses

200

Account Page TOTP credential list response.

Media type application/json

object

credentials

required

Array<object>

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

total

required

integer

backup_codes

required

object

total

required

integer

remaining

required

integer

Example

{
  "credentials": [
    {
      "algorithm": "SHA1",
      "digits": 6,
      "status": "pending"
    }
  ]
}

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"
}

500

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"
}