Create MFA Policy Override Toggle

Creates the given MFA policy override toggle. If the upsert query param is set to true then instead of performing a create the API will switch to performing an upsert. For an upsert request the following fields are required:

Required Upsert Fields:

  • ownerType
  • ownerId

When performing an upsert, the above fields will be used to determine if the MFA policy override toggle resource already exists or not. If the MFA policy override toggle already exists, then a partial update will be performed on the existing MFA policy override toggle; otherwise a new MFA policy override toggle entity will be created.

In the response of an upsert request, if a create was performed then a 201 response code will be returned; otherwise, if an update was performed then a 200 will be returned.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission the allowed permission boundaries are also specified.

PermissionBoundaryDescription
mfa-policy:writeApplicationThe subject can create override toggles under the application that the subject belongs to.
TenantThe subject can create override toggles associated to the tenant that the subject belongs to.
Tenant Inclusion ListThe subject can create override toggles for tenants specified in the tenant inclusion list.
Tenant Exclusion ListThe subject can create override toggles for tenants that belong to the subject's application but are not included in the tenant exclusion list.
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

Override Toggle JSON object

string
required
length between 1 and 30

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

string
required
length between 1 and 26

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

string
length between 1 and 45
Defaults to DISABLED

The override toggle's current status

Responses

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