Skip to content

user.totp_device

Manage TOTP devices

Confirm

Path
POST /v7.0/users/{user_id}/totp_devices/{totp_device_id}/confirm
Description
Confirm device
Authentication required
yes
Scope
user.totp_device#confirm
Aliases
Blocking
no

Input parameters

Layout
hash
Namespace
totp_device
ParameterTypeRequiredDetails
code
TOTP code
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
hash
Namespace
totp_device
ParameterTypeDescription
recovery_code
Recovery_code
 String

Create

Path
POST /v7.0/users/{user_id}/totp_devices
Description
Create a new TOTP device
Authentication required
yes
Scope
user.totp_device#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
totp_device
ParameterTypeRequiredDetails
label
Label
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
totp_device
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
confirmed
Confirmed
 Boolean
enabled
Enabled
 Boolean
last_use_at
Last_use_at
 Datetime
use_count
Use_count
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime
secret
Secret
 String
provisioning_uri
Provisioning_uri
 String

Delete

Path
DELETE /v7.0/users/{user_id}/totp_devices/{totp_device_id}
Description
Delete TOTP device
Authentication required
yes
Scope
user.totp_device#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/users/{user_id}/totp_devices
Description
List configured TOTP devices
Authentication required
yes
Scope
user.totp_device#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
totp_device
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
confirmed
Confirmed
 Boolean no

Default: null
enabled
Enabled
 Boolean no

Default: null

Output parameters

Layout
object_list
Namespace
totp_devices
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
confirmed
Confirmed
 Boolean
enabled
Enabled
 Boolean
last_use_at
Last_use_at
 Datetime
use_count
Use_count
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/users/{user_id}/totp_devices/{totp_device_id}
Description
Show configured TOTP device
Authentication required
yes
Scope
user.totp_device#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
totp_device
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
confirmed
Confirmed
 Boolean
enabled
Enabled
 Boolean
last_use_at
Last_use_at
 Datetime
use_count
Use_count
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/users/{user_id}/totp_devices/{totp_device_id}
Description
Update device label
Authentication required
yes
Scope
user.totp_device#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
totp_device
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
enabled
Enabled
 Boolean no

Default: null

Output parameters

Layout
object
Namespace
totp_device
ParameterTypeDescription
id
Id
 Integer
label
Label
 String
confirmed
Confirmed
 Boolean
enabled
Enabled
 Boolean
last_use_at
Last_use_at
 Datetime
use_count
Use_count
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime