Delete one current user's TOTP credential.

DELETE

/api/account/totp/{id}

Code sample: Shell / cURL

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

Deletes a TOTP credential. A current TOTP code or backup code is required for active credentials unless the session was recently reauthenticated with TOTP.

Authorizations

• accountSessionCookie

Parameters

Path Parameters

id

required

string

Request Body

Media type application/json

object

code

string

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

backup_code

string

Example ^generated

{
  "code": "example",
  "backup_code": "example"
}

Responses

200

Account Page TOTP credential delete response.

Media type application/json

object

ok

required

boolean

credential

required

object

id

required

string

deleted

required

boolean

Example ^generated

{
  "ok": true,
  "credential": {
    "id": "example",
    "deleted": true
  }
}

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