How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Auth0 guardian API

The guardian API from Auth0 — 18 operation(s) for guardian.

Auth0 guardian API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Guardian. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 36 operations across 18 paths, and defines 64 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

36 operations 18 paths 64 schemas 1 DELETE14 GET5 PATCH1 POST15 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Auth0 guardian API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 36

Across 18 paths, the API surfaces 36 operations — 1 DELETE, 14 GET, 5 PATCH, 1 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.

guardian 36
POST
/guardian/enrollments/ticket
Create a Multi-factor Authentication Enrollment Ticket
post_ticket body → 200400401403404
GET
/guardian/enrollments/{id}
Get a Multi-factor Authentication Enrollment
get_enrollments_by_id 1 param → 200400401403
DELETE
/guardian/enrollments/{id}
Delete a Multi-factor Authentication Enrollment
delete_enrollments_by_id 1 param → 204400401403
GET
/guardian/factors
Get Factors and Multi-factor Authentication Details
get_factors → 200400401403
GET
/guardian/factors/duo/settings
Get DUO Configuration
get_factor_duo_settings → 200400401403
PATCH
/guardian/factors/duo/settings
Update the DUO Configuration
patch_factor_duo_settings body → 200400401403
PUT
/guardian/factors/duo/settings
Set the DUO Configuration
put_factor_duo_settings body → 200400401403
GET
/guardian/factors/phone/message-types
Get Enabled Phone Factors
get_message-types → 200400401403
PUT
/guardian/factors/phone/message-types
Update the Enabled Phone Factors
put_message-types body → 200400401403404
GET
/guardian/factors/phone/providers/twilio
Get Twilio Configuration
get_phone_twilio_factor_provider → 200400401403
PUT
/guardian/factors/phone/providers/twilio
Update Twilio Configuration
put_twilio body → 200400401403
GET
/guardian/factors/phone/selected-provider
Get Phone Provider Configuration
get_guardian_phone_providers → 200400401403
PUT
/guardian/factors/phone/selected-provider
Update Phone Provider Configuration
put_phone_providers body → 200400401403
GET
/guardian/factors/phone/templates
Get Enrollment and Verification Phone Templates
get_factor_phone_templates → 200400401403
PUT
/guardian/factors/phone/templates
Update Enrollment and Verification Phone Templates
put_factor_phone_templates body → 200400401403
GET
/guardian/factors/push-notification/providers/apns
Get APNS Push Notification Configuration
get_apns → 200400401403
PATCH
/guardian/factors/push-notification/providers/apns
Update APNs Provider Configuration
patch_apns body → 200400401403
PUT
/guardian/factors/push-notification/providers/apns
Update APNS Configuration
put_apns body → 200400401403
PATCH
/guardian/factors/push-notification/providers/fcm
Updates FCM Configuration
patch_fcm body → 200400401403
PUT
/guardian/factors/push-notification/providers/fcm
Overwrite FCM Configuration
put_fcm body → 200400401403
PATCH
/guardian/factors/push-notification/providers/fcmv1
Updates FCMV1 Configuration
patch_fcmv1 body → 200400401403
PUT
/guardian/factors/push-notification/providers/fcmv1
Overwrite FCMV1 Configuration
put_fcmv1 body → 200400401403
GET
/guardian/factors/push-notification/providers/sns
Get AWS SNS Configuration
get_sns → 200400401403
PATCH
/guardian/factors/push-notification/providers/sns
Update AWS SNS Configuration
patch_sns body → 200400401403
PUT
/guardian/factors/push-notification/providers/sns
Configure AWS SNS Configuration
put_sns body → 200400401403
GET
/guardian/factors/push-notification/selected-provider
Get Push Notification Provider
get_pn_providers → 200400401403
PUT
/guardian/factors/push-notification/selected-provider
Update Push Notification Configuration
put_pn_providers body → 200400401403
GET
/guardian/factors/sms/providers/twilio
Get Twilio SMS Configuration
get_sms_twilio_factor_provider → 200400401403
PUT
/guardian/factors/sms/providers/twilio
Update Twilio SMS Configuration
put_sms_twilio_factor_provider body → 200400401403
GET
/guardian/factors/sms/selected-provider
Get SMS Configuration
get_sms_providers → 200400401403
PUT
/guardian/factors/sms/selected-provider
Update SMS Configuration
put_sms_providers body → 200400401403
GET
/guardian/factors/sms/templates
Get SMS Enrollment and Verification Templates
get_factor_sms_templates → 200204400401403
PUT
/guardian/factors/sms/templates
Update SMS Enrollment and Verification Templates
put_factor_sms_templates body → 200400401403
PUT
/guardian/factors/{name}
Update Multi-factor Authentication Type
put_factors_by_name 1 param body → 200400401403
GET
/guardian/policies
Get Multi-factor Authentication Policies
get_policies → 200400401403
PUT
/guardian/policies
Update Multi-factor Authentication Policies
put_policies body → 200400401403

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are GetGuardianEnrollmentResponseContent (7 properties), CreateGuardianEnrollmentTicketRequestContent (6 properties), SetGuardianFactorsProviderPushNotificationSnsResponseContent (5 properties), UpdateGuardianFactorsProviderPushNotificationSnsResponseContent (5 properties). Each schema is shown below with its type and property counts.

SetGuardianFactorDuoSettingsRequestContent
object
3 properties
GuardianFactor
object
3 properties 1 required
UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent
object
SetGuardianFactorSmsTemplatesResponseContent
object
2 properties 2 required
UpdateGuardianFactorDuoSettingsRequestContent
object
3 properties
SetGuardianFactorPhoneTemplatesRequestContent
object
2 properties 2 required
SetGuardianFactorsProviderPhoneTwilioResponseContent
object
4 properties
GuardianEnrollmentDate
string
Enrollment date and time.
SetGuardianFactorsProviderSmsTwilioRequestContent
object
4 properties
UpdateGuardianFactorsProviderPushNotificationFcmResponseContent
object
GetGuardianFactorsProviderSmsTwilioResponseContent
object
4 properties
GetGuardianFactorsProviderPushNotificationResponseContent
object
1 property
SetGuardianFactorsProviderPushNotificationResponseContent
object
1 property
ListGuardianPoliciesResponseContent
array
GuardianFactorNameEnum
string
Factor name. Can be sms, push-notification, email, duo otp webauthn-roaming, webauthn-platform, or recovery-code.
SetGuardianFactorResponseContent
object
1 property 1 required
GetGuardianFactorPhoneMessageTypesResponseContent
object
1 property
UpdateGuardianFactorsProviderPushNotificationSnsResponseContent
object
5 properties
GetGuardianFactorSmsTemplatesResponseContent
object
2 properties 2 required
GetGuardianFactorsProviderSnsResponseContent
object
5 properties
SetGuardianFactorsProviderPushNotificationRequestContent
object
1 property 1 required
GetGuardianFactorPhoneTemplatesResponseContent
object
2 properties 2 required
SetGuardianPoliciesResponseContent
array
SetGuardianFactorsProviderPushNotificationSnsRequestContent
object
5 properties
GuardianFactorPhoneFactorMessageTypeEnum
string
UpdateGuardianFactorsProviderPushNotificationFcmRequestContent
object
1 property
SetGuardianPoliciesRequestContent
array
SetGuardianFactorsProviderSmsResponseContent
object
1 property
SetGuardianFactorRequestContent
object
1 property 1 required
SetGuardianFactorsProviderPushNotificationApnsResponseContent
object
2 properties
SetGuardianFactorsProviderPushNotificationSnsResponseContent
object
5 properties
SetGuardianFactorsProviderSmsRequestContent
object
1 property 1 required
MFAPolicyEnum
string
The MFA policy
SetGuardianFactorsProviderPushNotificationFcmRequestContent
object
1 property
GuardianEnrollmentStatus
string
Status of this enrollment. Can be pending or confirmed.
UpdateGuardianFactorsProviderPushNotificationApnsResponseContent
object
2 properties
SetGuardianFactorsProviderPushNotificationFcmResponseContent
object
GetGuardianFactorsProviderPhoneResponseContent
object
1 property
SetGuardianFactorSmsTemplatesRequestContent
object
2 properties 2 required
SetGuardianFactorDuoSettingsResponseContent
object
3 properties
SetGuardianFactorPhoneMessageTypesResponseContent
object
1 property
GetGuardianFactorsProviderPhoneTwilioResponseContent
object
4 properties
CreateGuardianEnrollmentTicketResponseContent
object
2 properties
SetGuardianFactorsProviderSmsTwilioResponseContent
object
4 properties
SetGuardianFactorsProviderPhoneTwilioRequestContent
object
4 properties
SetGuardianFactorsProviderPushNotificationFcmv1RequestContent
object
1 property
SetGuardianFactorsProviderPhoneResponseContent
object
1 property
GetGuardianFactorDuoSettingsResponseContent
object
3 properties
UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent
object
1 property
GuardianFactorsProviderPushNotificationProviderDataEnum
string
SetGuardianFactorPhoneMessageTypesRequestContent
object
1 property 1 required
GetGuardianFactorsProviderSmsResponseContent
object
1 property
CreateGuardianEnrollmentTicketRequestContent
object
6 properties 1 required
UpdateGuardianFactorDuoSettingsResponseContent
object
3 properties
UpdateGuardianFactorsProviderPushNotificationApnsRequestContent
object
3 properties
GetGuardianFactorsProviderApnsResponseContent
object
3 properties
SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent
object
GetGuardianEnrollmentResponseContent
object
7 properties 1 required
SetGuardianFactorsProviderPhoneRequestContent
object
1 property 1 required
GuardianEnrollmentFactorEnum
string
Optional. Specifies which factor the user must enroll with. Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or cust…
SetGuardianFactorsProviderPushNotificationApnsRequestContent
object
3 properties
GuardianFactorsProviderSmsProviderEnum
string
UpdateGuardianFactorsProviderPushNotificationSnsRequestContent
object
5 properties
SetGuardianFactorPhoneTemplatesResponseContent
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-guardian-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
Auth0 My Organization API
Auth0 for AI Agents
Auth0 actions API
Auth0 anomaly API
Auth0 Assertions API
Auth0 attack-protection API
Auth0 Authorization Models API
Auth0 Authorize User API
Auth0 AuthZenService API
Auth0 branding API
Auth0 client-grants API
Where this information came from

This is an independent, third-party profile of Auth0 guardian API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.