Auth0 API | Guardian

Guardian

guardian

Enrollments

guardian.enrollments

Methods

Delete A Multi Factor Authentication Enrollment ->

delete/guardian/enrollments/{id}

Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review Reset User Multi-Factor Authentication and Recovery Codes.

Get A Multi Factor Authentication Enrollment ->

Enrollment

get/guardian/enrollments/{id}

Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.

Create A Multi Factor Authentication Enrollment Ticket -> { ticket_id, ticket_url }

post/guardian/enrollments/ticket

Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket, to a given user.

Domain types

Enrollment = { id, enrolled_at, identifier, 4 more... }

Guardian

Factors

guardian.factors

Methods

Get Factors And Multi Factor Authentication Details -> Array<

Factor

get/guardian/factors

Retrieve details of all multi-factor authentication factors associated with your tenant.

Update Multi Factor Authentication Type -> { enabled }

put/guardian/factors/{name}

Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.

Domain types

Factor = { enabled, name, trial_expired }

Guardian Factors

Phone

guardian.factors.phone

Guardian Factors Phone

Message Types

guardian.factors.phone.message_types

Methods

Get Enabled Phone Factors -> { message_types }

get/guardian/factors/phone/message-types

Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

Update The Enabled Phone Factors -> { message_types }

put/guardian/factors/phone/message-types

Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

Guardian Factors Phone

Providers

guardian.factors.phone.providers

Guardian Factors Phone Providers

Twilio

guardian.factors.phone.providers.twilio

Methods

Get Twilio Configuration ->

TwilioFactorProvider

get/guardian/factors/phone/providers/twilio

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.

Update Twilio Configuration ->

TwilioFactorProvider

put/guardian/factors/phone/providers/twilio

Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.

Domain types

TwilioFactorProvider = { auth_token, from, messaging_service_sid, 1 more... }

Guardian Factors Phone

Selected Provider

guardian.factors.phone.selected_provider

Methods

Get Phone Provider Configuration -> { provider }

get/guardian/factors/phone/selected-provider

Retrieve details of the multi-factor authentication phone provider configured for your tenant.

Update Phone Provider Configuration -> { provider }

put/guardian/factors/phone/selected-provider

Update phone provider configuration

Guardian Factors Phone

Templates

guardian.factors.phone.templates

Methods

Get Enrollment And Verification Phone Templates ->

TemplateMessages

get/guardian/factors/phone/templates

Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.

Update Enrollment And Verification Phone Templates ->

TemplateMessages

put/guardian/factors/phone/templates

Customize the messages sent to complete phone enrollment and verification (subscription required).

Guardian Factors

Push Notification

guardian.factors.push_notification

Guardian Factors Push Notification

Providers

guardian.factors.push_notification.providers

Guardian Factors Push Notification Providers

Apns

guardian.factors.push_notification.providers.apns

Methods

Get Apns Push Notification Configuration -> { bundle_id, enabled, sandbox }

get/guardian/factors/push-notification/providers/apns

Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.

Update Apns Configuration -> { bundle_id, sandbox }

put/guardian/factors/push-notification/providers/apns

Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.

Guardian Factors Push Notification Providers

Fcm

guardian.factors.push_notification.providers.fcm

Methods

Updates Fcm Configuration -> Record<string, unknown>

put/guardian/factors/push-notification/providers/fcm

Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.

Guardian Factors Push Notification Providers

Sns

guardian.factors.push_notification.providers.sns

Methods

Get Aws Sns Configuration -> { aws_access_key_id, aws_region, aws_secret_access_key, 2 more... }

get/guardian/factors/push-notification/providers/sns

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review Configure Push Notifications for MFA.

Update Aws Sns Configuration -> { aws_access_key_id, aws_region, aws_secret_access_key, 2 more... }

put/guardian/factors/push-notification/providers/sns

Configure the AWS SNS push notification provider configuration (subscription required).

Guardian Factors Push Notification

Selected Provider

guardian.factors.push_notification.selected_provider

Methods

Get Push Notification Provider -> { provider }

get/guardian/factors/push-notification/selected-provider

Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.

Update Push Notification Configuration -> { provider }

put/guardian/factors/push-notification/selected-provider

Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.

Guardian Factors

SMS

guardian.factors.sms

Guardian Factors SMS

Providers

guardian.factors.sms.providers

Guardian Factors SMS Providers

Twilio

guardian.factors.sms.providers.twilio

Methods

Get Twilio SMS Configuration ->

SMSTwilioFactorProvider

get/guardian/factors/sms/providers/twilio

Retrieve the Twilio SMS provider configuration (subscription required).

A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a target='_blank' href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.

Update Twilio SMS Configuration ->

SMSTwilioFactorProvider

put/guardian/factors/sms/providers/twilio

This endpoint has been deprecated. To complete this action, use the Update Twilio phone configuration endpoint.

<b>Previous functionality</b>: Update the Twilio SMS provider configuration.

Domain types

SMSTwilioFactorProvider = { auth_token, from, messaging_service_sid, 1 more... }

Guardian Factors SMS

Selected Provider

guardian.factors.sms.selected_provider

Methods

Get SMS Configuration -> { provider }

get/guardian/factors/sms/selected-provider

This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead.

<b>Previous functionality</b>: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.

Update SMS Configuration -> { provider }

put/guardian/factors/sms/selected-provider

This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead.

<b>Previous functionality</b>: Update the multi-factor authentication SMS provider configuration in your tenant.

Guardian Factors SMS

Templates

guardian.factors.sms.templates

Methods

Get SMS Enrollment And Verification Templates ->

TemplateMessages

get/guardian/factors/sms/templates

This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead.

<b>Previous function</b>: Retrieve details of SMS enrollment and verification templates configured for your tenant.

Update SMS Enrollment And Verification Templates ->

TemplateMessages

put/guardian/factors/sms/templates

This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead.

<b>Previous functionality</b>: Customize the messages sent to complete SMS enrollment and verification.

Guardian

Policies

guardian.policies

Methods

Get Multi Factor Authentication Policies -> Array<"all-applications" | "confidence-score">

get/guardian/policies

Retrieve the multi-factor authentication (MFA) policies configured for your tenant.

The following policies are supported:

all-applications policy prompts with MFA for all logins.
confidence-score policy prompts with MFA only for low confidence logins.

Note: The confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.

Update Multi Factor Authentication Policies -> Array<"all-applications" | "confidence-score">

put/guardian/policies

Set multi-factor authentication (MFA) policies for your tenant.

The following policies are supported:

all-applications policy prompts with MFA for all logins.
confidence-score policy prompts with MFA only for low confidence logins.

Note: The confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.