Site Home
API Reference
LoginTry for Free

Create MFA Policy

post
https://{application_vanity_domain}/api/v1/mfa-policies
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Boolean indicating if the operation should be treated as an upsert

Body Params

MFA policy JSON object

string
string
enum
required
length between 1 and 30

[Required on Create and Upsert] The type of the owner of the resource.

Allowed:
string
required
length between 1 and 26

[Required on Create and Upsert] The ID of the owner of the resource.

string
enum
length between 1 and 45
Defaults to OPTIONAL

The strategy that should be used to enroll users in MFA.

StrategyDescription
OPTIONALThe user can optionally choose to enroll in MFA on their own accord.
REQUIREDThe user is required to enroll in MFA. When users attempt to sign up or log in to the application, they will be required to enroll in MFA if they have not already done so.
Allowed:
allowedAuthFactors
array of strings

Array of auth factors that a user is allowed to enroll in. If the enrollmentStrategy is set to REQUIRED then this value can't be empty. Also, RECOVERY_CODE can't be the only allowed auth factor.

totpSettings
object
string
Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago