Actions
- GETGet actions
- POSTCreate an action
- GETGet an action's versions
- GETGet a specific version of an action
- POSTRoll back to a previous action version
- GETGet an action
- DELDelete an action
- PATCHUpdate an action
- POSTDeploy an action
- POSTTest an Action
- GETGet an execution
- GETList Actions Modules
- POSTCreate a new Actions Module
- GETGet a specific Actions Module by ID
- DELDelete a specific Actions Module by ID
- PATCHUpdate a specific Actions Module
- GETList all actions using an Actions Module
- POSTRollback an Actions Module to a previous version
- GETList all versions of an Actions Module
- POSTCreate a new version of an Actions Module
- GETGet a specific version of an Actions Module
- GETGet triggers
- GETGet trigger bindings
- PATCHUpdate trigger bindings
Attack Protection
- GETGet Bot Detection settings
- PATCHUpdate Bot Detection settings
- GETGet Breached Password Detection settings
- PATCHUpdate Breached Password Detection settings
- GETGet Brute-force settings
- PATCHUpdate Brute-force settings
- GETGet the CAPTCHA configuration for a tenant
- PATCHPartial Update for CAPTCHA Configuration
- GETGet Suspicious IP Throttling settings
- PATCHUpdate Suspicious IP Throttling settings
Branding
- GETGet branding settings
- PATCHUpdate branding settings
- GETGet a list of phone providers
- POSTConfigure the phone provider
- GETGet a phone provider
- DELDeletes a Phone Provider
- PATCHUpdate the phone provider
- POSTSend a test phone notification for the configured provider
- GETGet a list of phone notification templates
- POSTCreate a phone notification template
- GETGet a phone notification template
- DELDelete a phone notification template
- PATCHUpdate a phone notification template
- PATCHResets a phone notification template values
- POSTSend a test phone notification for the configured template
- GETGet template for New Universal Login Experience
- DELDelete template for New Universal Login Experience
- PUTSet template for New Universal Login Experience
- POSTCreate branding theme
- GETGet default branding theme
- GETGet branding theme
- DELDelete branding theme
- PATCHUpdate branding theme
Client Grants
Clients
- GETGet clients
- POSTCreate a client
- POSTPreview and validate Client ID Metadata Document
- POSTRegister or update a CIMD client via metadata URI
- GETGet client credentials
- POSTCreate a client credential
- GETGet client credential details
- DELDelete a client credential
- PATCHUpdate a client credential
- GETGet client by ID
- DELDelete a client
- PATCHUpdate a client
- GETGet enabled connections for a client
- POSTRotate a client secret
Connection Profiles
Connections
- GETGet all connections
- POSTCreate a connection
- GETGet a connection
- DELDelete a connection
- PATCHUpdate a connection
- GETGet enabled clients for a connection
- PATCHUpdate enabled clients for a connection
- GETGet a directory provisioning configuration
- DELDelete a directory provisioning configuration
- PATCHPatch a directory provisioning configuration
- POSTCreate a directory provisioning configuration
- GETGet a connection's default directory provisioning attribute mapping
- POSTRequest an on-demand synchronization of the directory
- GETGet synchronized groups for a directory provisioning configuration
- PUTCreate or replace synchronized group selections for a directory provisioning configuration
- GETGet connection keys
- POSTCreate connection keys
- POSTRotate connection keys
- GETGet a connection's SCIM configuration
- DELDelete a connection's SCIM configuration
- PATCHPatch a connection's SCIM configuration
- POSTCreate a SCIM configuration
- GETGet a connection's default SCIM mapping
- GETGet a connection's SCIM tokens
- POSTCreate a SCIM Token
- DELDelete a connection's SCIM token
- GETCheck connection status
- DELDelete a connection user
Connections Directory Provisionings
Connections Scim Configurations
Custom Domains
- GETGet custom domains configurations
- POSTConfigure a new custom domain
- GETGet the default domain
- PATCHUpdate the default custom domain for the tenant
- GETGet custom domain configuration
- DELDelete custom domain configuration
- PATCHUpdate custom domain configuration
- POSTTest a custom domain
- POSTVerify a custom domain
Device Credentials
Email Templates
Emails
Event Streams
- GETGet event streams
- POSTCreate an event stream
- GETGet an event stream by ID
- DELDelete an event stream
- PATCHUpdate an event stream
- GETGet this event stream's delivery history
- GETGet a specific event's delivery history
- POSTRedeliver failed events
- POSTRedeliver a single failed event by ID
- POSTSend a test event to an event stream
Experimentation
- GETList experiments for the tenant.
- POSTCreate an experiment for the Experiment Center.
- GETGet an experiment by ID.
- DELDelete an experiment.
- PATCHUpdate an experiment.
- POSTTransition an experiment to a new status.
- POSTValidate an experiment.
- GETList feature flags for the tenant.
- POSTCreate a feature flag for the Experiment Center.
- GETGet a feature flag by ID.
- DELDelete a feature flag.
- PATCHUpdate a feature flag.
- POSTTransition a feature flag to a new status.
- GETList all variations for a feature flag.
- POSTCreate a variation for a feature flag.
- GETGet a variation by ID.
- DELDelete a variation.
- PATCHUpdate a variation.
- GETList segments for the tenant.
- POSTCreate a segment for the Experiment Center.
- GETGet a segment by ID.
- DELDelete a segment.
- PATCHUpdate a segment.
Flows
- GETGet flows
- POSTCreate a flow
- GETGet Flows Vault connection list
- POSTCreate a Flows Vault connection
- GETGet a Flows Vault connection
- DELDelete a Flows Vault connection
- PATCHUpdate a Flows Vault connection
- GETGet flow executions
- GETGet a flow execution
- DELDelete a flow execution
- GETGet a flow
- DELDelete a flow
- PATCHUpdate a flow
Groups
Guardian
- POSTCreate a multi-factor authentication enrollment ticket
- GETGet a multi-factor authentication enrollment
- DELDelete a multi-factor authentication enrollment
- GETGet Factors and multi-factor authentication details
- GETGet DUO Configuration
- PATCHUpdate the DUO Configuration
- PUTSet the DUO Configuration
- GETGet Enabled Phone Factors
- PUTUpdate the Enabled Phone Factors
- GETGet Twilio configuration
- PUTUpdate Twilio configuration
- GETGet phone provider configuration
- PUTUpdate phone provider configuration
- GETGet Enrollment and Verification Phone Templates
- PUTUpdate Enrollment and Verification Phone Templates
- GETGet APNS push notification configuration
- PATCHUpdate APNs provider configuration
- PUTUpdate APNS configuration
- PATCHUpdates FCM configuration
- PUTOverwrite FCM configuration
- PATCHUpdates FCMV1 configuration
- PUTOverwrite FCMV1 configuration
- GETGet AWS SNS configuration
- PATCHUpdate AWS SNS configuration
- PUTConfigure AWS SNS configuration
- GETGet push notification provider
- PUTUpdate Push Notification configuration
- GETGet Twilio SMS configuration
- PUTUpdate Twilio SMS configuration
- GETGet SMS configuration
- PUTUpdate SMS configuration
- GETGet SMS enrollment and verification templates
- PUTUpdate SMS enrollment and verification templates
- PUTUpdate multi-factor authentication type
- GETGet multi-factor authentication policies
- PUTUpdate multi-factor authentication policies
Hooks
Jobs
Keys
- GETGet custom signing keys
- DELDelete custom signing keys
- PUTCreate or replace custom signing keys
- GETGet all encryption keys
- POSTCreate the new encryption key
- POSTRekey the key hierarchy
- GETGet the encryption key by its key id
- DELDelete the encryption key by its key id
- POSTImport the encryption key
- POSTCreate the public wrapping key
- GETGet all Application Signing Keys
- POSTRotate the Application Signing Key
- GETGet an Application Signing Key by its key id
- PUTRevoke an Application Signing Key by its key id
Log Streams
Network Acls
Organizations
- GETGet organizations
- POSTCreate an Organization
- GETGet organization by name
- GETGet organization
- DELDelete organization
- PATCHModify an Organization
- GETGet client grants associated to an organization
- POSTAssociate a client grant with an organization
- DELRemove a client grant from an organization
- GETGet connections associated with an organization
- POSTAdds a connection to an organization
- GETGet a specific connection associated with an organization
- DELDelete a connection from an organization
- PATCHUpdate a connection for an organization
- GETRetrieve all organization discovery domains
- POSTCreate an organization discovery domain
- GETRetrieve an organization discovery domain by domain name
- GETRetrieve an organization discovery domain by ID
- DELDelete an organization discovery domain
- PATCHUpdate an organization discovery domain
- GETGet connections enabled for an organization
- POSTAdd connections to an organization
- GETGet an enabled connection for an organization
- DELDelete connections from an organization
- PATCHUpdate the Connection of an Organization
- GETGet invitations to an organization
- POSTCreate invitations to an organization
- GETGet a specific invitation to an Organization
- DELDelete an invitation to an Organization
- GETGet members who belong to an organization
- DELDelete members from an organization
- POSTAdd members to an organization
- GETList organization member effective roles.
- GETList organization member role group sources.
- GETGet user roles assigned to an Organization member
- DELDelete user roles from an Organization member
- POSTAssign user roles to an Organization member
- GETLists the groups that are assigned to the organization.
- GETLists the roles assigned to a group in the context of an organization.
- DELRemoves roles assigned to a group in an organization context.
- POSTAssigns roles to a group in an organization context.
Prompts
- GETGet prompt settings
- PATCHUpdate prompt settings
- GETGet render setting configurations for all screens
- PATCHUpdate render settings for multiple screens
- GETGet custom text for a prompt
- PUTSet custom text for a specific prompt
- GETGet partials for a prompt
- PUTSet partials for a prompt
- GETGet render settings for a screen
- PATCHUpdate render settings for a screen
Rate Limit Policies
Refresh Tokens
Resource Servers
Risk Assessments
Roles
- GETGet roles
- POSTCreate a role
- GETGet a role
- DELDelete a role
- PATCHUpdate a role
- GETGet a role's groups
- DELRemove groups from a role
- POSTAssign groups to a role
- GETGet permissions granted by role
- DELRemove permissions from a role
- POSTAssociate permissions with a role
- GETGet a role's users
- POSTAssign users to a role
Rules Configs
Self Service Profiles
- GETGet self-service profiles
- POSTCreate a self-service profile
- GETGet a self-service profile by Id
- DELDelete a self-service profile by Id
- PATCHUpdate a self-service profile
- GETGet custom text for a self-service profile
- PUTSet custom text for a self-service profile
- POSTCreate an access ticket to initiate the Self-Service Enterprise Configuration flow
- POSTRevoke a Self-Service Enterprise Configuration access ticket
Supplemental Signals
Token Exchange Profiles
User Attribute Profiles
User Blocks
Users
- GETList or Search Users
- POSTCreate a User
- GETGet a User
- DELDelete a User
- PATCHUpdate a User
- GETGet a list of authentication methods
- DELDelete all authentication methods for the given user
- POSTCreates an authentication method for a given user
- PUTUpdate all authentication methods by replacing them with the given ones
- GETGet an authentication method by ID
- DELDelete an authentication method by ID
- PATCHUpdate an authentication method
- DELDelete All Authenticators
- GETGet a User's Connected Accounts
- GETLists the permissions assigned to a user directly or through roles or groups.
- GETLists the roles which grant the user a given permission (whether directly or through groups).
- GETLists the roles for a user with sources: directly assigned or through group membership.
- GETGet a user's role source groups
- GETGet the First Confirmed Multi-factor Authentication (MFA) Enrollment
- GETGet tokensets for a user
- DELDeletes a tokenset for federated connections by id.
- GETGet user's groups
- POSTLink a User Account
- DELUnlink a User Identity
- GETGet user's log events
- POSTInvalidate All Remembered Browsers for Multi-factor Authentication (MFA)
- DELDelete a User's Multi-factor Provider
- GETList user's organizations
- GETGet a User's Permissions
- DELRemove Permissions from a User
- POSTAssign Permissions to a User
- POSTGenerate New Multi-factor Authentication (MFA) Recovery Code
- POSTRevokes selected resources from a user
- POSTClear risk assessment assessors for a specific user
- GETGet a user's roles
- DELRemoves roles from a user
- POSTAssign roles to a user
- GETGet refresh tokens for a user
- DELDelete refresh tokens for a user
- GETGet sessions for user
- DELDelete sessions for user
Users By Email
Create a segment for the Experiment Center.
curl --request POST \
--url https://{tenantDomain}/api/v2/experimentation/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"rules": [
{
"match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
},
"not_match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
}
}
],
"description": "<string>"
}
'{
"id": "<string>",
"name": "<string>",
"type": "self",
"rules": [
{
"match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
},
"not_match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}Create a segment for the Experiment Center.
Create a new segment with rule-based membership criteria for use in experiments.
POST
https://{tenantDomain}/api/v2
/
experimentation
/
segments
Create a segment for the Experiment Center.
curl --request POST \
--url https://{tenantDomain}/api/v2/experimentation/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"rules": [
{
"match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
},
"not_match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
}
}
],
"description": "<string>"
}
'{
"id": "<string>",
"name": "<string>",
"type": "self",
"rules": [
{
"match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
},
"not_match": {
"client_id": [
"<string>"
],
"connection": [
"<string>"
],
"connection_type": [
"<string>"
],
"organization_id": [
"<string>"
],
"domain": [
"<string>"
],
"device_type": [
"<string>"
],
"browser": [
"<string>"
],
"platform": [
"<string>"
],
"user_agent": [
"<string>"
],
"country": [
"<string>"
],
"region": [
"<string>"
]
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://auth0.com/llms.txt
Use this file to discover all available pages before exploring further.
承認
bearerAuthoAuth2ClientCredentials
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ボディ
application/jsonapplication/x-www-form-urlencoded
Create a segment for experiment targeting
A human-readable name for the segment
Required string length:
3 - 255Pattern:
^(?!.*\x00)\S(.*\S)?$An ordered list of rules. A segment matches if any rule matches.
Minimum array length:
1Show child attributes
Show child attributes
A description of the segment
Required string length:
3 - 1024Pattern:
^(?!.*\x00)\S(.*\S)?$このページは役に立ちましたか？
⌘I
アシスタント
AIにより生成された回答には誤りが含まれる可能性があります。