HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Create a time-based one-time password enrollment.

post
https://{tenanturl}/v2.0/factors/totp

Create a time-based one-time password enrollment.

If the authenticated user has the entitlement 'manageEnrollMFAMethodAnyUser', then the 'userId' attribute must be present in the request payload. Otherwise, the enrollment is associated with the authenticated user.

Entitlements:
- manageEnrollMFAMethodAnyUser (Manage second-factor authentication enrollment for all users)
- manageEnrollMFAMethod (Manage own second-factor authentication enrollment)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Query Params
boolean

If included and set to 'true', and the Accept header of the request is 'application/json', then the JSON response payload will include a base64 encoded representation of the QR code.

Body Params

A JSON payload that specifies the enrollment data.

The creation data of a time-based one-time password enrollment.

string

The unique identifier of the associated user

string

The account name that the one-time password is associated with

boolean

The enabled state of the enrollment to be used in runtime flows

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json
image/png

Updated over 2 years ago