Authentication & Authorization — entry 001 of 4

Auth0

Verified Jul 2026

Auth0 (an Okta company) is an identity platform providing hosted login, social and enterprise SSO, and adaptive multi-factor authentication for web, mobile, and API-first applications. Both its Authentication API and Management API are secured exclusively through OAuth 2.0 / OIDC bearer tokens issued via a tenant's /oauth/token endpoint — there is no standalone API-key scheme. It bills per monthly active user, with a free tier for small projects and paid Essentials/Professional/Enterprise plans for scale.

authenticationoauthidentityssomfa

Visit auth0.com ↗Read the docs ↗More Authentication & Authorization

AuthenticationOAuthRequires an OAuth flow; expect app registration.

HTTPSSupportedTraffic is encrypted in transit.

CORSEnabledCallable directly from browser JavaScript.

PricingFreemiumA usable free tier exists, with paid plans for more volume.

FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score74out of 100

Authentication8/25OAuth flow required

Pricing17/20Freemium tier available

Docs20/20Machine-readable spec file bundled

Formats9/15Single response format

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/auth0/"><img src="https://greatapis.com/badge/auth0.svg" alt="Scored 74 on greatapis.com"></a>

Auth quickstart

Register an app / run the OAuth flow to obtain a bearer token.
Send it as an Authorization headerAuthorization: Bearer <token>

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://{tenantDomain}/api/v2

Auth

bearerAuthoAuth2ClientCredentials

actions24

GET/actions/actionsGet actions

Parameters

Name	In	Required	Type
`triggerId`	query	no	—
`actionName`	query	no	string
`deployed`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`installed`	query	no	boolean

Responses

Status	Description	Schema
`200`	The actions were retrieved.	`ListActionsPaginatedResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/actionsCreate an action

Request body

application/json — CreateActionRequestContent

Responses

Status	Description	Schema
`201`	Action successfully created.	`CreateActionResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/actions/{actionId}/versionsGet an action's versions

Parameters

Name	In	Required	Type
`actionId`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	The action versions were retrieved.	`ListActionVersionsPaginatedResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/actions/{actionId}/versions/{id}Get a specific version of an action

Parameters

Name	In	Required	Type
`actionId`	path	yes	string
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The action version was retrieved.	`GetActionVersionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	The action version does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/actions/{actionId}/versions/{id}/deployRoll back to a previous action version

Parameters

Name	In	Required	Type
`id`	path	yes	string
`actionId`	path	yes	string

Request body

application/json — DeployActionVersionRequestContent

Responses

Status	Description	Schema
`202`	Request to create action version was accepted.	`DeployActionVersionResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/actions/{id}Get an action

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The action was retrieved.	`GetActionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	The action does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/actions/actions/{id}Update an action

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateActionRequestContent

Responses

Status	Description	Schema
`200`	Action successfully updated.	`UpdateActionResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: update:actions.	—
`404`	Action not found and cannot be updated.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/actions/actions/{id}Delete an action

Parameters

Name	In	Required	Type
`id`	path	yes	string
`force`	query	no	boolean

Responses

Status	Description	Schema
`204`	Action successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: delete:actions.	—
`404`	The action version does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/actions/{id}/deployDeploy an action

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Request to create action version was accepted.	`DeployActionResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/actions/{id}/testTest an Action

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — TestActionRequestContent

Responses

Status	Description	Schema
`200`	Test action version successfully created.	`TestActionResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/executions/{id}Get an execution

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The execution was retrieved.	`GetActionExecutionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	The execution does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/modulesList Actions Modules

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	The action modules were retrieved.	`GetActionModulesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/modulesCreate a new Actions Module

Request body

application/json — CreateActionModuleRequestContent

Responses

Status	Description	Schema
`201`	The action module was created.	`CreateActionModuleResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:actions.	—
`409`	An action module with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/modules/{id}Get a specific Actions Module by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The action module was retrieved.	`GetActionModuleResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	The action module does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/actions/modules/{id}Update a specific Actions Module

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateActionModuleRequestContent

Responses

Status	Description	Schema
`200`	The action module was updated.	`UpdateActionModuleResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: update:actions.	—
`404`	The action module does not exist.	—
`409`	An action module with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/actions/modules/{id}Delete a specific Actions Module by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The Actions Module was deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: delete:actions.	—
`404`	The Actions Module does not exist.	—
`412`	The Actions Module cannot be deleted because it is in use by one or more actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/modules/{id}/actionsList all actions using an Actions Module

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	The actions were retrieved.	`GetActionModuleActionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	No module exists with the specified ID.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/modules/{id}/rollbackRollback an Actions Module to a previous version

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — RollbackActionModuleRequestContent

Responses

Status	Description	Schema
`200`	The rollback was successful.	`RollbackActionModuleResponseContent`
`400`	Invalid request URI or body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: update:actions.	—
`404`	The module or version does not exist.	—
`409`	The specified version is already the current draft version.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/modules/{id}/versionsList all versions of an Actions Module

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	The module versions were retrieved.	`GetActionModuleVersionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	No module exists with the specified ID.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/actions/modules/{id}/versionsCreate a new version of an Actions Module

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The action module version was created.	`CreateActionModuleVersionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: update:actions.	—
`404`	The action module does not exist.	—
`409`	No draft version is available to publish.	—
`412`	Maximum number of module versions reached. Consolidate versions used in actions before creating new ones.	—

GET/actions/modules/{id}/versions/{versionId}Get a specific version of an Actions Module

Parameters

Name	In	Required	Type
`id`	path	yes	string
`versionId`	path	yes	string

Responses

Status	Description	Schema
`200`	The module version was retrieved.	`GetActionModuleVersionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`404`	The module or version does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/triggersGet triggers

Responses

Status	Description	Schema
`200`	The triggers were retrieved.	`ListActionTriggersResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/actions/triggers/{triggerId}/bindingsGet trigger bindings

Parameters

Name	In	Required	Type
`triggerId`	path	yes	—
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	The bindings were retrieved.	`ListActionBindingsPaginatedResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/actions/triggers/{triggerId}/bindingsUpdate trigger bindings

Parameters

Name	In	Required	Type
`triggerId`	path	yes	—

Request body

application/json — UpdateActionBindingsRequestContent

Responses

Status	Description	Schema
`200`	The bindings were updated.	`UpdateActionBindingsResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: update:actions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

anomaly2

GET/anomaly/blocks/ips/{id}Check if an IP address is blocked

Parameters

Name	In	Required	Type
`id`	path	yes	—

Responses

Status	Description	Schema
`200`	IP address specified is currently blocked.	—
`400`	Connection does not exist.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: get:anomaly_block.	—
`404`	IP address specified is not currently blocked.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/anomaly/blocks/ips/{id}Remove the blocked IP address

Parameters

Name	In	Required	Type
`id`	path	yes	—

Responses

Status	Description	Schema
`204`	IP address specified successfully unblocked.	—
`400`	Connection does not exist.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:anomaly_block.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

attack-protection12

GET/attack-protection/bot-detectionGet Bot Detection settings

Responses

Status	Description	Schema
`200`	Bot detection configuration retrieved successfully.	`GetBotDetectionSettingsResponseContent`
`401`	Invalid token.	—
`403`	Please upgrade your subscription to use bot detection	—
`404`	Bot detection configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/attack-protection/bot-detectionUpdate Bot Detection settings

Request body

application/json — UpdateBotDetectionSettingsRequestContent

Responses

Status	Description	Schema
`200`	Bot detection configuration successfully updated.	`UpdateBotDetectionSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Please upgrade your subscription to use bot detection	—
`404`	Bot detection configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/attack-protection/breached-password-detectionGet Breached Password Detection settings

Responses

Status	Description	Schema
`200`	Breached password detection settings successfully retrieved.	`GetBreachedPasswordDetectionSettingsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:attack_protection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/attack-protection/breached-password-detectionUpdate Breached Password Detection settings

Request body

application/json — UpdateBreachedPasswordDetectionSettingsRequestContent

Responses

Status	Description	Schema
`200`	Breached password detection settings successfully updated.	`UpdateBreachedPasswordDetectionSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:attack_protection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/attack-protection/brute-force-protectionGet Brute-force settings

Responses

Status	Description	Schema
`200`	Brute force configuration successfully retrieved.	`GetBruteForceSettingsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:attack_protection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/attack-protection/brute-force-protectionUpdate Brute-force settings

Request body

application/json — UpdateBruteForceSettingsRequestContent

Responses

Status	Description	Schema
`200`	Brute force configuration successfully updated.	`UpdateBruteForceSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:attack_protection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/attack-protection/captchaGet the CAPTCHA configuration for a tenant

Responses

Status	Description	Schema
`200`	Captcha configuration successfully retrieved.	`GetAttackProtectionCaptchaResponseContent`
`401`	Invalid token.	—
`403`	Please upgrade your subscription to use bot detection	—
`404`	Captcha configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/attack-protection/captchaPartial Update for CAPTCHA Configuration

Request body

application/json — UpdateAttackProtectionCaptchaRequestContent

Responses

Status	Description	Schema
`200`	Captcha configuration successfully retrieved.	`UpdateAttackProtectionCaptchaResponseContent`
`401`	Invalid token.	—
`403`	Please upgrade your subscription to use bot detection	—
`404`	Captcha configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/attack-protection/phone-provider-protectionGet Phone Provider Protection settings

Responses

Status	Description	Schema
`200`	Phone provider protection configuration successfully retrieved.	`GetPhoneProviderProtectionResponseContent`
`401`	Invalid token.	—
`403`	Exponential backoff is not enabled for this tenant.	—
`404`	Phone provider protection configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/attack-protection/phone-provider-protectionUpdate Phone Provider Protection settings

Request body

application/json — PatchPhoneProviderProtectionRequestContent

Responses

Status	Description	Schema
`200`	Phone provider protection configuration successfully updated.	`PatchPhoneProviderProtectionResponseContent`
`401`	Invalid token.	—
`403`	Exponential backoff is not enabled for this tenant.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/attack-protection/suspicious-ip-throttlingGet Suspicious IP Throttling settings

Responses

Status	Description	Schema
`200`	Suspicious IP throttling configuration successfully retrieved.	`GetSuspiciousIPThrottlingSettingsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:attack_protection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/attack-protection/suspicious-ip-throttlingUpdate Suspicious IP Throttling settings

Request body

application/json — UpdateSuspiciousIPThrottlingSettingsRequestContent

Responses

Status	Description	Schema
`200`	Suspicious IP throttling configuration successfully updated.	`UpdateSuspiciousIPThrottlingSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:attack_protection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

branding23

GET/brandingGet branding settings

Responses

Status	Description	Schema
`200`	Branding settings successfully retrieved.	`GetBrandingResponseContent`
`401`	Invalid token.	—
`403`	The specified client cannot perform the requested operation.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/brandingUpdate branding settings

Request body

application/json — UpdateBrandingRequestContent

Responses

Status	Description	Schema
`200`	Branding settings successfully updated.	`UpdateBrandingResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:branding.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/phone/providersGet a list of phone providers

Parameters

Name	In	Required	Type
`disabled`	query	no	boolean

Responses

Status	Description	Schema
`200`	Phone providers have been successfully retrieved.	`ListBrandingPhoneProvidersResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:phone_provider.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/branding/phone/providersConfigure the phone provider

Request body

application/json — CreateBrandingPhoneProviderRequestContent

Responses

Status	Description	Schema
`201`	Phone notification provider successfully created.	`CreateBrandingPhoneProviderResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:phone_provider.	—
`409`	Custom phone provider conflict.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/phone/providers/{id}Get a phone provider

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Phone provider successfully retrieved.	`GetBrandingPhoneProviderResponseContent`
`400`	Invalid id for provider.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:phone_provider.	—
`404`	Phone provider has not been configured.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/branding/phone/providers/{id}Update the phone provider

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateBrandingPhoneProviderRequestContent

Responses

Status	Description	Schema
`200`	Phone provider successfully updated.	`UpdateBrandingPhoneProviderResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:phone_provider.	—
`404`	Phone provider has not been configured.	—
`409`	Custom phone provider conflict.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/branding/phone/providers/{id}Deletes a Phone Provider

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Phone provider successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:phone_provider.	—
`404`	Phone provider has not been configured.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/branding/phone/providers/{id}/trySend a test phone notification for the configured provider

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreatePhoneProviderSendTestRequestContent

Responses

Status	Description	Schema
`202`	Phone notification sent.	`CreatePhoneProviderSendTestResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:phone_provider.	—
`404`	Phone provider has not been configured.	—
`409`	Custom phone provider conflict.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/phone/templatesGet a list of phone notification templates

Parameters

Name	In	Required	Type
`disabled`	query	no	boolean

Responses

Status	Description	Schema
`200`	The phone notification templates were retrieved.	`ListPhoneTemplatesResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:phone_templates	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/branding/phone/templatesCreate a phone notification template

Request body

application/json — CreatePhoneTemplateRequestContent

Responses

Status	Description	Schema
`201`	The phone notification template was created.	`CreatePhoneTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: create:phone_templates	—
`409`	Phone template already configured for tenant	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/phone/templates/{id}Get a phone notification template

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The phone notification template were retrieved.	`GetPhoneTemplateResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:phone_templates	—
`404`	Phone template does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/branding/phone/templates/{id}Update a phone notification template

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdatePhoneTemplateRequestContent

Responses

Status	Description	Schema
`200`	The phone notification template was updated.	`UpdatePhoneTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: update:phone_templates	—
`404`	Phone template does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/branding/phone/templates/{id}Delete a phone notification template

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The phone notification template was deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: delete:phone_templates	—
`404`	Phone template does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/branding/phone/templates/{id}/resetResets a phone notification template values

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — ResetPhoneTemplateRequestContent

Responses

Status	Description	Schema
`200`	The phone notification template was reset.	`ResetPhoneTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: create:phone_templates	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/branding/phone/templates/{id}/trySend a test phone notification for the configured template

Parameters

Name	In	Required	Type
`id`	path	yes	string
`auth0-custom-domain`	header	no	string

Request body

application/json — CreatePhoneTemplateTestNotificationRequestContent

Responses

Status	Description	Schema
`202`	The phone testing notification for the template was sent	`CreatePhoneTemplateTestNotificationResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: create:phone_templates	—
`404`	Phone template does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/templates/universal-loginGet template for New Universal Login Experience

Responses

Status	Description	Schema
`200`	Template successfully retrieved.	`GetUniversalLoginTemplateResponseContent`
`401`	Invalid token.	—
`402`	A paid subscription is required for this feature.	—
`403`	Insufficient scope; expected: read:branding	—
`404`	Template does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/branding/templates/universal-loginSet template for New Universal Login Experience

Request body

application/json — UpdateUniversalLoginTemplateRequestContent

Responses

Status	Description	Schema
`201`	Template successfully created.	—
`204`	Template successfully updated.	—
`400`	Payload content length greater than maximum allowed: 102400.	—
`401`	Invalid token.	—
`402`	A paid subscription is required for this feature.	—
`403`	Insufficient scope; expected: update:branding.	—
`409`	Template update conflict.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/branding/templates/universal-loginDelete template for New Universal Login Experience

Responses

Status	Description	Schema
`204`	Template successfully deleted.	—
`401`	Invalid token.	—
`402`	A paid subscription is required for this feature.	—
`403`	Insufficient scope; expected: delete:branding.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/branding/themesCreate branding theme

Request body

application/json — CreateBrandingThemeRequestContent

Responses

Status	Description	Schema
`200`	Branding settings successfully updated.	`CreateBrandingThemeResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:branding.	—
`409`	There was an error updating branding settings: The theme already exists	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/themes/defaultGet default branding theme

Responses

Status	Description	Schema
`200`	Branding theme successfully retrieved.	`GetBrandingDefaultThemeResponseContent`
`401`	Invalid token.	—
`403`	The specified client cannot perform the requested operation.	—
`404`	There was an error retrieving branding settings: invalid theme ID	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/branding/themes/{themeId}Get branding theme

Parameters

Name	In	Required	Type
`themeId`	path	yes	string

Responses

Status	Description	Schema
`200`	Branding theme successfully retrieved.	`GetBrandingThemeResponseContent`
`401`	Invalid token.	—
`403`	The specified client cannot perform the requested operation.	—
`404`	There was an error retrieving branding settings: invalid theme ID	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/branding/themes/{themeId}Update branding theme

Parameters

Name	In	Required	Type
`themeId`	path	yes	string

Request body

application/json — UpdateBrandingThemeRequestContent

Responses

Status	Description	Schema
`200`	Branding settings successfully updated.	`UpdateBrandingThemeResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:branding.	—
`404`	There was an error updating branding settings: invalid theme ID	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/branding/themes/{themeId}Delete branding theme

Parameters

Name	In	Required	Type
`themeId`	path	yes	string

Responses

Status	Description	Schema
`204`	Branding theme successfully deleted.	—
`401`	Invalid token.	—
`403`	The specified client cannot perform the requested operation.	—
`404`	There was an error deleting branding settings: invalid theme ID	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

client-grants6

GET/client-grantsGet client grants

Parameters

Name	In	Required	Type
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer
`audience`	query	no	string
`client_id`	query	no	string
`allow_any_organization`	query	no	—
`subject_type`	query	no	—
`default_for`	query	no	—

Responses

Status	Description	Schema
`200`	Client grants successfully retrieved.	`ListClientGrantResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:client_grants.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/client-grantsCreate client grant

Request body

application/json — CreateClientGrantRequestContent

Responses

Status	Description	Schema
`201`	Client grant successfully created.	`CreateClientGrantResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:client_grants.	—
`404`	Resource server not found	—
`409`	A resource server with the same identifier already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/client-grants/{id}Get client grant

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Client grant successfully retrieved.	`GetClientGrantResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:client_grants.	—
`404`	The grant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/client-grants/{id}Update client grant

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateClientGrantRequestContent

Responses

Status	Description	Schema
`200`	Client grant successfully updated.	`UpdateClientGrantResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:client_grants.	—
`404`	The client grant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/client-grants/{id}Delete client grant

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Client grant successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:client_grants.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/client-grants/{id}/organizationsGet the organizations associated to a client grant

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Organizations successfully retrieved.	`ListClientGrantOrganizationsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_client_grants.	—
`404`	The grant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

clients14

GET/clientsGet clients

Parameters

Name	In	Required	Type
`fields`	query	no	string
`include_fields`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer
`is_global`	query	no	boolean
`is_first_party`	query	no	boolean
`app_type`	query	no	string
`external_client_id`	query	no	string
`q`	query	no	string

Responses

Status	Description	Schema
`200`	Clients successfully retrieved.	—
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:clients, read:client_keys, read:client_summary	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/clientsCreate a client

Request body

application/json — CreateClientRequestContent

Responses

Status	Description	Schema
`201`	Client successfully created.	`CreateClientResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:clients.	—
`404`	The Client ID for Invitations could not be found.	—
`409`	Another client exists with the same alias.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/clients/cimd/previewPreview and validate Client ID Metadata Document

Request body

application/json — PreviewCimdMetadataRequestContent

Responses

Status	Description	Schema
`200`	Metadata successfully fetched and validated, or retrieval error returned with errors array.	`PreviewCimdMetadataResponseContent`
`400`	Invalid external_client_id. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:clients, update:clients.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	An internal server error occurred.	—

POST/clients/cimd/registerRegister or update a CIMD client via metadata URI

Request body

application/json — RegisterCimdClientRequestContent

Responses

Status	Description	Schema
`200`	CIMD client successfully updated (idempotent).	`RegisterCimdClientResponseContent`
`201`	CIMD client successfully created.	`RegisterCimdClientResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:clients, update:clients.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	An internal server error occurred.	—

GET/clients/{client_id}/credentialsGet client credentials

Parameters

Name	In	Required	Type
`client_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Credentials successfully retrieved.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:client_credentials.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/clients/{client_id}/credentialsCreate a client credential

Parameters

Name	In	Required	Type
`client_id`	path	yes	string

Request body

application/json — PostClientCredentialRequestContent

Responses

Status	Description	Schema
`201`	Credential successfully created.	`PostClientCredentialResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:client_credentials.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/clients/{client_id}/credentials/{credential_id}Get client credential details

Parameters

Name	In	Required	Type
`client_id`	path	yes	string
`credential_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Credential successfully retrieved.	`GetClientCredentialResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:client_credentials.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/clients/{client_id}/credentials/{credential_id}Update a client credential

Parameters

Name	In	Required	Type
`client_id`	path	yes	string
`credential_id`	path	yes	string

Request body

application/json — PatchClientCredentialRequestContent

Responses

Status	Description	Schema
`201`	Credential successfully updated.	`PatchClientCredentialResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:client_credentials.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/clients/{client_id}/credentials/{credential_id}Delete a client credential

Parameters

Name	In	Required	Type
`client_id`	path	yes	string
`credential_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Credential successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:client_credentials.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/clients/{id}Get client by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Client successfully retrieved.	`GetClientResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:clients, read:client_keys, read:client_credentials, read:client_summary.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/clients/{id}Update a client

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateClientRequestContent

Responses

Status	Description	Schema
`200`	Client successfully updated.	`UpdateClientResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:clients, update:client_keys.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/clients/{id}Delete a client

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Client successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:clients.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/clients/{id}/connectionsGet enabled connections for a client

Parameters

Name	In	Required	Type
`id`	path	yes	string
`strategy`	query	no	array
`from`	query	no	string
`take`	query	no	integer
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Success	`ListClientConnectionsResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: read:connections and any of: read:clients or read:client_summary.	—
`404`	Client does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/clients/{id}/rotate-secretRotate a client secret

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Secret successfully rotated.	`RotateClientSecretResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:client_keys.	—
`404`	Client not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

connection-profiles7

GET/connection-profilesGet Connection Profiles

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Connection Profiles successfully retrieved.	`ListConnectionProfilesPaginatedResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:connection_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/connection-profilesCreate a connection profile

Request body

application/json — CreateConnectionProfileRequestContent

Responses

Status	Description	Schema
`201`	Connection profile successfully created.	`CreateConnectionProfileResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:connection_profiles.	—
`409`	Connection profile conflict.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connection-profiles/templatesGet Connection Profile Templates

Responses

Status	Description	Schema
`200`	Connection Profile Templates successfully retrieved.	`ListConnectionProfileTemplateResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:connection_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connection-profiles/templates/{id}Get Connection Profile Template

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Connection Profile Template successfully retrieved.	`GetConnectionProfileTemplateResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:connection_profiles.	—
`404`	Connection profile template not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connection-profiles/{id}Get Connection Profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Record for existing connection profile.	`GetConnectionProfileResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:connection-profiles.	—
`404`	Connection profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/connection-profiles/{id}Modify a Connection Profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateConnectionProfileRequestContent

Responses

Status	Description	Schema
`200`	Connection profile successfully updated.	`UpdateConnectionProfileResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:connection_profiles.	—
`404`	Connection profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/connection-profiles/{id}Delete Connection Profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Connection profile successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:connection-profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

connections28

GET/connectionsGet all connections

Parameters

Name	In	Required	Type
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer
`strategy`	query	no	array
`name`	query	no	string
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	The connections were retrieved.	`ListConnectionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:connections	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/connectionsCreate a connection

Request body

application/json — CreateConnectionRequestContent

Responses

Status	Description	Schema
`201`	The connection was created.	`CreateConnectionResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: create:connections	—
`409`	A connection with the same name already exists	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}Get a connection

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	The connection was retrieved.	`GetConnectionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:connections	—
`404`	The connection does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/connections/{id}Update a connection

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateConnectionRequestContent

Responses

Status	Description	Schema
`200`	The connection was updated.	`UpdateConnectionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: update:connections	—
`404`	The connection does not exist	—
`409`	The name/client_id tuple has already been used for another connection	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/connections/{id}Delete a connection

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	The connection is being deleted.	—
`204`	The connection no longer exists.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: delete:connections	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}/clientsGet enabled clients for a connection

Parameters

Name	In	Required	Type
`id`	path	yes	string
`take`	query	no	integer
`from`	query	no	string

Responses

Status	Description	Schema
`200`	Success	`GetConnectionEnabledClientsResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:connections	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/connections/{id}/clientsUpdate enabled clients for a connection

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateEnabledClientConnectionsRequestContent

Responses

Status	Description	Schema
`204`	Success	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: update:connections	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}/directory-provisioningGet a directory provisioning configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The connection's directory provisioning configuration. See <strong>Response Schemas</strong> for schema.	`GetDirectoryProvisioningResponseContent`
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	The inbound directory provisioning feature is not enabled for this tenant	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/connections/{id}/directory-provisioningCreate a directory provisioning configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateDirectoryProvisioningRequestContent

Responses

Status	Description	Schema
`201`	The connection's directory provisioning configuration was created. See <strong>Response Schemas</strong> for schema.	`CreateDirectoryProvisioningResponseContent`
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	The inbound directory provisioning feature is not enabled for this tenant	—
`404`	The connection does not exist	—
`409`	Directory provisioning is already enabled on the specified connection	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/connections/{id}/directory-provisioningPatch a directory provisioning configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateDirectoryProvisioningRequestContent

Responses

Status	Description	Schema
`200`	The connection's directory provisioning configuration was updated. See <strong>Response Schemas</strong> for schema.	`UpdateDirectoryProvisioningResponseContent`
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	The inbound directory provisioning feature is not enabled for this tenant	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/connections/{id}/directory-provisioningDelete a directory provisioning configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The connection's directory provisioning configuration has been deleted.	—
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	The inbound directory provisioning feature is not enabled for this tenant	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}/directory-provisioning/default-mappingGet a connection's default directory provisioning attribute mapping

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The connection's directory provisioning default mapping. See <strong>Response Schemas</strong> for schema.	`GetDirectoryProvisioningDefaultMappingResponseContent`
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	The inbound directory provisioning feature is not enabled for this tenant	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/connections/{id}/directory-provisioning/synchronizationsRequest an on-demand synchronization of the directory

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	The directory synchronization was triggered. See <strong>Response Schemas</strong> for schema.	`CreateDirectorySynchronizationResponseContent`
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:directory_provisionings.	—
`404`	The connection does not exist	—
`409`	A synchronization has already been requested or is in progress for the connection	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}/directory-provisioning/synchronized-groupsGet synchronized groups for a directory provisioning configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	The connection's synchronized groups. See <strong>Response Schemas</strong> for schema.	`ListSynchronizedGroupsResponseContent`
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	Synchronized groups selection is not enabled for this tenant	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/connections/{id}/directory-provisioning/synchronized-groupsCreate or replace synchronized group selections for a directory provisioning configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — ReplaceSynchronizedGroupsRequestContent

Responses

Status	Description	Schema
`204`	No Content	—
`400`	Path validation error	—
`401`	Invalid token.	—
`403`	Synchronized groups selection is not enabled for this tenant	—
`404`	The connection does not exist	—
`409`	Conflict	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}/keysGet connection keys

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Connection keys successfully retrieved.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:connections_keys.	—
`404`	Connection not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/connections/{id}/keysCreate connection keys

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — PostConnectionKeysRequestContent

Responses

Status	Description	Schema
`201`	Connection keys successfully created.	`PostConnectionsKeysResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:connections_keys.	—
`404`	Connection not found.	—
`409`	Keys have already been created for this connection.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/connections/{id}/keys/rotateRotate connection keys

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — RotateConnectionKeysRequestContent

Responses

Status	Description	Schema
`201`	Connection keys successfully rotated.	`RotateConnectionsKeysResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected all of: create:connections_keys, update:connections_keys.	—
`404`	Connection not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/connections/{id}/scim-configurationGet a connection's SCIM configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The connection's SCIM configuration was retrieved. See <strong>Response Schemas</strong> for schema.	`GetScimConfigurationResponseContent`
`400`	Path validation error	—
`404`	The connection does not exist	—

POST/connections/{id}/scim-configurationCreate a SCIM configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateScimConfigurationRequestContent

Responses

Status	Description	Schema
`201`	The connection's SCIM configuration was created. See <strong>Response Schemas</strong> for schema.	`CreateScimConfigurationResponseContent`
`400`	Path validation error	—
`404`	The connection does not exist	—

PATCH/connections/{id}/scim-configurationPatch a connection's SCIM configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateScimConfigurationRequestContent

Responses

Status	Description	Schema
`200`	The connection's SCIM configuration was updated. See <strong>Response Schemas</strong> for schema.	`UpdateScimConfigurationResponseContent`
`400`	Invalid mapping provided	—
`404`	The connection does not exist	—

DELETE/connections/{id}/scim-configurationDelete a connection's SCIM configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The connection's SCIM configuration has been deleted.	—
`400`	Path validation error	—
`404`	The connection does not exist	—

GET/connections/{id}/scim-configuration/default-mappingGet a connection's default SCIM mapping

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The connection's default SCIM mapping was retrieved. See <strong>Response Schemas</strong> for schema.	`GetScimConfigurationDefaultMappingResponseContent`
`400`	Path validation error	—
`404`	Not Found	—

GET/connections/{id}/scim-configuration/tokensGet a connection's SCIM tokens

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The connection's SCIM tokens were retrieved. See <strong>Response Schemas</strong> for schema.	`GetScimTokensResponseContent`
`400`	Path validation error	—
`404`	The connection does not exist	—

POST/connections/{id}/scim-configuration/tokensCreate a SCIM Token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateScimTokenRequestContent

Responses

Status	Description	Schema
`201`	The connection's SCIM token was created. See <strong>Response Schemas</strong> for schema.	`CreateScimTokenResponseContent`
`400`	Path validation error	—
`404`	The connection does not exist	—
`409`	Maximum of 2 tokens already issued for this connection	—

DELETE/connections/{id}/scim-configuration/tokens/{tokenId}Delete a connection's SCIM token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tokenId`	path	yes	string

Responses

Status	Description	Schema
`204`	The SCIM token has been deleted.	—
`400`	Path validation error	—
`404`	The connection does not exist	—

GET/connections/{id}/statusCheck connection status

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Connection status successfully retrieved.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:connections.	—
`404`	Connection not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/connections/{id}/usersDelete a connection user

Parameters

Name	In	Required	Type
`id`	path	yes	string
`email`	query	yes	string

Responses

Status	Description	Schema
`204`	The user no longer exists.	—
`400`	Connection must be a database connection	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: delete:users	—
`404`	The connection does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

connections-directory-provisionings1

GET/connections-directory-provisioningsGet a list of directory provisioning configurations

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	The tenant's directory provisioning configuration. See <strong>Response Schemas</strong> for schema.	`ListDirectoryProvisioningsResponseContent`
`400`	Invalid pagination cursor	—
`401`	Invalid token.	—
`403`	The inbound directory provisioning feature is not enabled for this tenant	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

connections-scim-configurations1

GET/connections-scim-configurationsGet a list of SCIM configurations

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	The tenant's SCIM configurations. See <strong>Response Schema</strong> for schema.	`ListSCIMConfigurationsResponseContent`
`400`	Invalid pagination cursor.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:scim_config.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

custom-domains9

GET/custom-domainsGet custom domains configurations

Parameters

Name	In	Required	Type
`take`	query	no	integer
`from`	query	no	string
`q`	query	no	string
`fields`	query	no	string
`include_fields`	query	no	boolean
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	Custom domains successfully retrieved.	`ListCustomDomainsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:custom_domains.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/custom-domainsConfigure a new custom domain

Request body

application/json — CreateCustomDomainRequestContent

Responses

Status	Description	Schema
`201`	Custom domain successfully created (verification is pending).	`CreateCustomDomainResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:custom_domains.	—
`409`	Custom domain already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/custom-domains/defaultGet the default domain

Responses

Status	Description	Schema
`200`	Default domain successfully retrieved.	`GetDefaultDomainResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:custom_domains.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/custom-domains/defaultUpdate the default custom domain for the tenant

Request body

application/json — SetDefaultCustomDomainRequestContent

Responses

Status	Description	Schema
`200`	Default custom domain set successfully.	`UpdateDefaultDomainResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`403`	Insufficient scope; expected update:custom_domains.	—

GET/custom-domains/{id}Get custom domain configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Custom domain successfully retrieved.	`GetCustomDomainResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:custom_domains.	—
`404`	Custom domain not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/custom-domains/{id}Update custom domain configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateCustomDomainRequestContent

Responses

Status	Description	Schema
`200`	Custom domain updated.	`UpdateCustomDomainResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:custom_domains.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/custom-domains/{id}Delete custom domain configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Custom domain successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:custom_domains.	—
`409`	Cannot delete the default custom domain. Please set another domain as default before deleting this one.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/custom-domains/{id}/testTest a custom domain

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Custom domain test successfully completed.	`TestCustomDomainResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:custom_domains.	—
`404`	Custom domain not found.	—
`409`	The custom domain is not ready.	—

POST/custom-domains/{id}/verifyVerify a custom domain

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Custom domain successfully verified.	`VerifyCustomDomainResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:custom_domains.	—
`404`	Custom domain not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

device-credentials3

GET/device-credentialsRetrieve device credentials

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`fields`	query	no	string
`include_fields`	query	no	boolean
`user_id`	query	no	string
`client_id`	query	no	string
`type`	query	no	—

Responses

Status	Description	Schema
`200`	Device credentials successfully retrieved.	`ListDeviceCredentialsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/device-credentialsCreate a device public key credential

Request body

application/json — CreatePublicKeyDeviceCredentialRequestContent

Responses

Status	Description	Schema
`201`	Device credentials successfully created.	`CreatePublicKeyDeviceCredentialResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Cannot create device credentials for that user.	—
`409`	A public key already exists for the device.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/device-credentials/{id}Delete a device credential

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Device credentials successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:device_credentials, update:current_user, delete:current_user_device_credentials.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

email-templates4

POST/email-templatesCreate an email template

Request body

application/json — CreateEmailTemplateRequestContent

Responses

Status	Description	Schema
`200`	Template successfully created.	`CreateEmailTemplateResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: create:email_templates.	—
`409`	Template (templateName) already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/email-templates/{templateName}Get an email template

Parameters

Name	In	Required	Type
`templateName`	path	yes	—

Responses

Status	Description	Schema
`200`	Template successfully retrieved.	`GetEmailTemplateResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: read:email_templates.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/email-templates/{templateName}Update an email template

Parameters

Name	In	Required	Type
`templateName`	path	yes	—

Request body

application/json — SetEmailTemplateRequestContent

Responses

Status	Description	Schema
`200`	Template successfully updated.	`SetEmailTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:email_templates.	—
`404`	Template not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/email-templates/{templateName}Patch an email template

Parameters

Name	In	Required	Type
`templateName`	path	yes	—

Request body

application/json — UpdateEmailTemplateRequestContent

Responses

Status	Description	Schema
`200`	Template successfully updated.	`UpdateEmailTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:email_templates.	—
`404`	Template not found and cannot be updated.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

emails4

GET/emails/providerGet email provider

Parameters

Name	In	Required	Type
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Email provider successfully retrieved.	`GetEmailProviderResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:email_provider.	—
`404`	Email provider has not been configured.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/emails/providerConfigure email provider

Request body

application/json — CreateEmailProviderRequestContent

Responses

Status	Description	Schema
`201`	Email provider successfully created.	`CreateEmailProviderResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:email_provider.	—
`409`	Email provider is already configured.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/emails/providerUpdate email provider

Request body

application/json — UpdateEmailProviderRequestContent

Responses

Status	Description	Schema
`200`	Email provider successfully updated.	`UpdateEmailProviderResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:email_provider.	—
`404`	Email provider has not been configured.	—
`409`	No deployed action was found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/emails/providerDelete email provider

Responses

Status	Description	Schema
`204`	The email provider has been deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: delete:email_provider	—
`404`	Email provider does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

event-streams10

GET/event-streamsGet event streams

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Event streams successfully retrieved.	`ListEventStreamsResponseContent`
`400`	Invalid query string paging options. The message will vary depending on the cause	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:event_streams.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/event-streamsCreate an event stream

Request body

application/json

Responses

Status	Description	Schema
`201`	Event Stream stream created successfully.	`CreateEventStreamResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:event_streams.	—
`409`	You have reached the maximum number of event streams for your account OR Event stream name already in use.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/event-streams/{id}Get an event stream by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Event stream successfully retrieved.	`GetEventStreamResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:event_streams.	—
`404`	The event stream does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/event-streams/{id}Update an event stream

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateEventStreamRequestContent

Responses

Status	Description	Schema
`200`	Event stream successfully updated.	`UpdateEventStreamResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:event_streams.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/event-streams/{id}Delete an event stream

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The event stream was deleted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:event_streams.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/event-streams/{id}/deliveriesGet this event stream's delivery history

Parameters

Name	In	Required	Type
`id`	path	yes	string
`statuses`	query	no	string
`event_types`	query	no	string
`date_from`	query	no	string
`date_to`	query	no	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Event stream deliveries successfully retrieved.	—
`400`	Invalid query string paging options. The message will vary depending on the cause	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:event_streams, read:event_deliveries.	—
`404`	The event stream does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/event-streams/{id}/deliveries/{event_id}Get a specific event's delivery history

Parameters

Name	In	Required	Type
`id`	path	yes	string
`event_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Delivery history for event successfully retrieved.	`GetEventStreamDeliveryHistoryResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:event_deliveries.	—
`404`	The event stream does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/event-streams/{id}/redeliverRedeliver failed events

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateEventStreamRedeliveryRequestContent

Responses

Status	Description	Schema
`202`	Redelivery request accepted.	`CreateEventStreamRedeliveryResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:event_deliveries.	—
`404`	The event stream does not exist.	—
`409`	One or more events is not in a state that allows redelivery.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/event-streams/{id}/redeliver/{event_id}Redeliver a single failed event by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`event_id`	path	yes	string

Responses

Status	Description	Schema
`202`	Redelivery request accepted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:event_deliveries.	—
`404`	The event stream does not exist.	—
`409`	The event is not in a state that allows redelivery.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/event-streams/{id}/testSend a test event to an event stream

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateEventStreamTestEventRequestContent

Responses

Status	Description	Schema
`202`	Test event successfully submitted.	`CreateEventStreamTestEventResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:event_streams.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

events1

GET/eventsSubscribe to events via Server-Sent Events (SSE)

Parameters

Name	In	Required	Type
`from`	query	no	string
`from_timestamp`	query	no	string
`event_type`	query	no	—

Responses

Status	Description	Schema
`200`	Event stream successfully established.	`EventStreamSubscribeEventsResponseContent`
`400`	Invalid cursor format.	—
`401`	Invalid token.	—
`403`	Maximum concurrent event stream connections reached. Please close existing connections.	—
`404`	Not found	—
`410`	Cursor points to data no longer available in the stream.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

experimentation23

GET/experimentation/experimentsList experiments for the tenant.

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer
`status`	query	no	—
`authentication_flow`	query	no	string
`feature_flag_id`	query	no	string

Responses

Status	Description	Schema
`200`	Experiments successfully retrieved.	`ListExperimentsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/experimentation/experimentsCreate an experiment for the Experiment Center.

Request body

application/json — CreateExperimentRequestContent

Responses

Status	Description	Schema
`201`	Experiment successfully created.	`CreateExperimentResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:experimentation.	—
`404`	Feature flag not found.	—
`409`	An experiment with this name already exists.	—
`429`	Too many requests.	—

GET/experimentation/experiments/{id}Get an experiment by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Experiment successfully retrieved.	`GetExperimentResponseContent`
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Experiment not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/experimentation/experiments/{id}Update an experiment.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateExperimentRequestContent

Responses

Status	Description	Schema
`200`	Experiment successfully updated.	`UpdateExperimentResponseContent`
`400`	Allocations cannot be modified while the experiment is active.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Experiment not found.	—
`409`	An experiment with this name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/experimentation/experiments/{id}Delete an experiment.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Experiment successfully deleted.	—
`400`	Active experiments cannot be deleted. Pause or complete the experiment first.	—
`403`	Insufficient scope; expected any of: delete:experimentation.	—
`429`	Too many requests.	—

POST/experimentation/experiments/{id}/statusTransition an experiment to a new status.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateExperimentStatusRequestContent

Responses

Status	Description	Schema
`200`	Experiment status successfully updated.	`UpdateExperimentStatusResponseContent`
`400`	Status transition is not allowed.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Experiment not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/experimentation/experiments/{id}/validateValidate an experiment.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Experiment validation result returned.	`ValidateExperimentResponseContent`
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Experiment not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/experimentation/feature-flagsList feature flags for the tenant.

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer
`type`	query	no	—
`status`	query	no	—

Responses

Status	Description	Schema
`200`	Feature flags successfully retrieved.	`ListFeatureFlagsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/experimentation/feature-flagsCreate a feature flag for the Experiment Center.

Request body

application/json — CreateFeatureFlagRequestContent

Responses

Status	Description	Schema
`201`	Feature flag successfully created.	`CreateFeatureFlagResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:experimentation.	—
`409`	A feature flag with this name already exists.	—
`429`	Too many requests.	—

GET/experimentation/feature-flags/{id}Get a feature flag by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Feature flag successfully retrieved.	`GetFeatureFlagResponseContent`
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/experimentation/feature-flags/{id}Update a feature flag.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateFeatureFlagRequestContent

Responses

Status	Description	Schema
`200`	Feature flag successfully updated.	`UpdateFeatureFlagResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`409`	A feature flag with this name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/experimentation/feature-flags/{id}Delete a feature flag.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Feature flag successfully deleted.	—
`403`	Insufficient scope; expected any of: delete:experimentation.	—
`409`	Feature flag is in use by one or more non-archived experiments and cannot be deleted.	—
`429`	Too many requests.	—

POST/experimentation/feature-flags/{id}/statusTransition a feature flag to a new status.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateFeatureFlagStatusRequestContent

Responses

Status	Description	Schema
`200`	Feature flag status successfully updated.	`UpdateFeatureFlagStatusResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/experimentation/feature-flags/{id}/variationsList all variations for a feature flag.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Variations successfully retrieved.	`ListVariationsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/experimentation/feature-flags/{id}/variationsCreate a variation for a feature flag.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateVariationRequestContent

Responses

Status	Description	Schema
`201`	Variation successfully created.	`CreateVariationResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`409`	A variation with this name already exists on this feature flag.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/experimentation/feature-flags/{id}/variations/{vid}Get a variation by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`vid`	path	yes	string

Responses

Status	Description	Schema
`200`	Variation successfully retrieved.	`GetVariationResponseContent`
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/experimentation/feature-flags/{id}/variations/{vid}Update a variation.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`vid`	path	yes	string

Request body

application/json — UpdateVariationRequestContent

Responses

Status	Description	Schema
`200`	Variation successfully updated.	`UpdateVariationResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Feature flag not found.	—
`409`	A variation with this name already exists on this feature flag.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/experimentation/feature-flags/{id}/variations/{vid}Delete a variation.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`vid`	path	yes	string

Responses

Status	Description	Schema
`204`	Variation successfully deleted.	—
`400`	Feature flag must have at least one variation. Cannot delete the last variation.	—
`403`	Insufficient scope; expected any of: delete:experimentation.	—
`404`	Feature flag not found.	—
`409`	Variation is in use by one or more non-archived allocations and cannot be deleted.	—
`429`	Too many requests.	—

GET/experimentation/segmentsList segments for the tenant.

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer
`type`	query	no	—

Responses

Status	Description	Schema
`200`	Segments successfully retrieved.	`ListSegmentsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/experimentation/segmentsCreate a segment for the Experiment Center.

Request body

application/json — CreateSegmentRequestContent

Responses

Status	Description	Schema
`201`	Segment successfully created.	`CreateSegmentResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:experimentation.	—
`409`	A segment with this name already exists.	—
`429`	Too many requests.	—

GET/experimentation/segments/{id}Get a segment by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Segment successfully retrieved.	`GetSegmentResponseContent`
`401`	Invalid token.	—
`403`	Tenant not entitled to this feature.	—
`404`	Segment not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/experimentation/segments/{id}Update a segment.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateSegmentRequestContent

Responses

Status	Description	Schema
`200`	Segment successfully updated.	`UpdateSegmentResponseContent`
`400`	Invalid request body.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:experimentation.	—
`404`	Segment not found.	—
`409`	A segment with this name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/experimentation/segments/{id}Delete a segment.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Segment successfully deleted.	—
`403`	Insufficient scope; expected any of: delete:experimentation.	—
`409`	Segment is in use by one or more non-archived experiment allocations.	—
`429`	Too many requests.	—

flows13

GET/flowsGet flows

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`hydrate`	query	no	array
`synchronous`	query	no	boolean

Responses

Status	Description	Schema
`200`	Flows successfully retrieved.	`ListFlowsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:flows.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/flowsCreate a flow

Request body

application/json — CreateFlowRequestContent

Responses

Status	Description	Schema
`201`	Flow successfully created.	`CreateFlowResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:flows.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/flows/vault/connectionsGet Flows Vault connection list

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Vault connections successfully retrieved.	`ListFlowsVaultConnectionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:flows_vault_connections.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/flows/vault/connectionsCreate a Flows Vault connection

Request body

application/json — CreateFlowsVaultConnectionRequestContent

Responses

Status	Description	Schema
`201`	Connection successfully created.	`CreateFlowsVaultConnectionResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:flows_vault_connections.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/flows/vault/connections/{id}Get a Flows Vault connection

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Flow vault connection successfully retrieved.	`GetFlowsVaultConnectionResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:flows_vault_connections.	—
`404`	The Flow vault connection does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/flows/vault/connections/{id}Update a Flows Vault connection

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateFlowsVaultConnectionRequestContent

Responses

Status	Description	Schema
`200`	Flow vault connection successfully updated.	`UpdateFlowsVaultConnectionResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:flows_vault_connections.	—
`404`	The Flow vault connection does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/flows/vault/connections/{id}Delete a Flows Vault connection

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Connection successfully deleted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:flows_vault_connections.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/flows/{flow_id}/executionsGet flow executions

Parameters

Name	In	Required	Type
`flow_id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Flow executions successfully retrieved.	`GetFlowsExecutionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:flows_executions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/flows/{flow_id}/executions/{execution_id}Get a flow execution

Parameters

Name	In	Required	Type
`flow_id`	path	yes	string
`execution_id`	path	yes	string
`hydrate`	query	no	array

Responses

Status	Description	Schema
`200`	Flow execution successfully retrieved.	`GetFlowExecutionResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:flows_executions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/flows/{flow_id}/executions/{execution_id}Delete a flow execution

Parameters

Name	In	Required	Type
`flow_id`	path	yes	string
`execution_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Flow execution successfully deleted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:flows_executions.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/flows/{id}Get a flow

Parameters

Name	In	Required	Type
`id`	path	yes	string
`hydrate`	query	no	array

Responses

Status	Description	Schema
`200`	Flow successfully retrieved.	`GetFlowResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:flows.	—
`404`	The flow does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/flows/{id}Update a flow

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateFlowRequestContent

Responses

Status	Description	Schema
`200`	Flow successfully updated.	`UpdateFlowResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:flows.	—
`404`	The flow does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/flows/{id}Delete a flow

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Flow successfully deleted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:flows.	—
`404`	The flow does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

forms5

GET/formsGet forms

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`hydrate`	query	no	array

Responses

Status	Description	Schema
`200`	Forms successfully retrieved.	`ListFormsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:forms.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/formsCreate a form

Request body

application/json — CreateFormRequestContent

Responses

Status	Description	Schema
`201`	Form successfully created.	`CreateFormResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:forms.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/forms/{id}Get a form

Parameters

Name	In	Required	Type
`id`	path	yes	string
`hydrate`	query	no	array

Responses

Status	Description	Schema
`200`	Form successfully retrieved.	`GetFormResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:forms.	—
`404`	The form does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/forms/{id}Update a form

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateFormRequestContent

Responses

Status	Description	Schema
`200`	Form successfully updated.	`UpdateFormResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:forms.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/forms/{id}Delete a form

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Form successfully deleted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:forms.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

grants3

GET/grantsGet grants

Parameters

Name	In	Required	Type
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean
`user_id`	query	no	string
`client_id`	query	no	string
`audience`	query	no	string

Responses

Status	Description	Schema
`200`	Grants successfully retrieved.	`ListUserGrantsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:grants.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/grantsDelete a grant by user_id

Parameters

Name	In	Required	Type
`user_id`	query	yes	string

Responses

Status	Description	Schema
`204`	User grant successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:grants.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/grants/{id}Delete a grant by id

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	User grant successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:grants.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

groups7

GET/groupsGet all Groups

Parameters

Name	In	Required	Type
`connection_id`	query	no	string
`name`	query	no	string
`external_id`	query	no	string
`search`	query	no	string
`fields`	query	no	string
`include_fields`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Groups successfully retrieved.	`ListGroupsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:groups.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/groups/{id}Get a Group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Group successfully retrieved.	`GetGroupResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:groups.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/groups/{id}Delete a Group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Group successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:groups.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/groups/{id}/membersGet Group Members

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Group members successfully retrieved.	`GetGroupMembersResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:group_members.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/groups/{id}/rolesGet a group's roles

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Group's roles successfully retrieved.	`ListGroupRolesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:group_roles.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/groups/{id}/rolesAssign roles to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AssignGroupRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully assigned to group.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:group_roles.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/groups/{id}/rolesRemove roles from a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteGroupRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully removed from group.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:group_roles.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

guardian36

POST/guardian/enrollments/ticketCreate a multi-factor authentication enrollment ticket

Parameters

Name	In	Required	Type
`auth0-custom-domain`	header	no	string

Request body

application/json — CreateGuardianEnrollmentTicketRequestContent

Responses

Status	Description	Schema
`200`	Enrollment ticket successfully created.	`CreateGuardianEnrollmentTicketResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—
`404`	User not found.	—

GET/guardian/enrollments/{id}Get a multi-factor authentication enrollment

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Enrollment successfully retrieved.	`GetGuardianEnrollmentResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

DELETE/guardian/enrollments/{id}Delete a multi-factor authentication enrollment

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Enrollment successfully deleted.	—
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope (expected delete:enrollment).	—

GET/guardian/factorsGet Factors and multi-factor authentication details

Responses

Status	Description	Schema
`200`	Factors successfully retrieved.	—
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/factors/duo/settingsGet DUO Configuration

Responses

Status	Description	Schema
`200`	DUO settings successfully retrieved.	`GetGuardianFactorDuoSettingsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/duo/settingsSet the DUO Configuration

Request body

application/json — SetGuardianFactorDuoSettingsRequestContent

Responses

Status	Description	Schema
`200`	DUO settings successfully updated.	`SetGuardianFactorDuoSettingsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PATCH/guardian/factors/duo/settingsUpdate the DUO Configuration

Request body

application/json — UpdateGuardianFactorDuoSettingsRequestContent

Responses

Status	Description	Schema
`200`	DUO settings successfully updated.	`UpdateGuardianFactorDuoSettingsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/factors/phone/message-typesGet Enabled Phone Factors

Responses

Status	Description	Schema
`200`	Returns the enabled phone factors	`GetGuardianFactorPhoneMessageTypesResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PUT/guardian/factors/phone/message-typesUpdate the Enabled Phone Factors

Request body

application/json — SetGuardianFactorPhoneMessageTypesRequestContent

Responses

Status	Description	Schema
`200`	Returns selected SMS provider configuration	`SetGuardianFactorPhoneMessageTypesResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—
`404`	The phone factor does not exist.	—

GET/guardian/factors/phone/providers/twilioGet Twilio configuration

Responses

Status	Description	Schema
`200`	Twilio Phone configuration successfully retrieved.	`GetGuardianFactorsProviderPhoneTwilioResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/phone/providers/twilioUpdate Twilio configuration

Request body

application/json — SetGuardianFactorsProviderPhoneTwilioRequestContent

Responses

Status	Description	Schema
`200`	Twilio Phone configuration successfully updated.	`SetGuardianFactorsProviderPhoneTwilioResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/factors/phone/selected-providerGet phone provider configuration

Responses

Status	Description	Schema
`200`	Returns selected Phone provider configuration	`GetGuardianFactorsProviderPhoneResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PUT/guardian/factors/phone/selected-providerUpdate phone provider configuration

Request body

application/json — SetGuardianFactorsProviderPhoneRequestContent

Responses

Status	Description	Schema
`200`	Returns selected Phone provider configuration	`SetGuardianFactorsProviderPhoneResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

GET/guardian/factors/phone/templatesGet Enrollment and Verification Phone Templates

Responses

Status	Description	Schema
`200`	Phone enrollment and verification templates successfully retrieved.	`GetGuardianFactorPhoneTemplatesResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/phone/templatesUpdate Enrollment and Verification Phone Templates

Request body

application/json — SetGuardianFactorPhoneTemplatesRequestContent

Responses

Status	Description	Schema
`200`	Phone enrollment and verification templates successfully updated.	`SetGuardianFactorPhoneTemplatesResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/factors/push-notification/providers/apnsGet APNS push notification configuration

Responses

Status	Description	Schema
`200`	APNS configuration successfully retrieved.	`GetGuardianFactorsProviderApnsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/push-notification/providers/apnsUpdate APNS configuration

Request body

application/json — SetGuardianFactorsProviderPushNotificationApnsRequestContent

Responses

Status	Description	Schema
`200`	APNS configuration successfully updated.	`SetGuardianFactorsProviderPushNotificationApnsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PATCH/guardian/factors/push-notification/providers/apnsUpdate APNs provider configuration

Request body

application/json — UpdateGuardianFactorsProviderPushNotificationApnsRequestContent

Responses

Status	Description	Schema
`200`	APNS configuration successfully updated.	`UpdateGuardianFactorsProviderPushNotificationApnsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/push-notification/providers/fcmOverwrite FCM configuration

Request body

application/json — SetGuardianFactorsProviderPushNotificationFcmRequestContent

Responses

Status	Description	Schema
`200`	FCM configuration updated	`SetGuardianFactorsProviderPushNotificationFcmResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PATCH/guardian/factors/push-notification/providers/fcmUpdates FCM configuration

Request body

application/json — UpdateGuardianFactorsProviderPushNotificationFcmRequestContent

Responses

Status	Description	Schema
`200`	FCM configuration updated	`UpdateGuardianFactorsProviderPushNotificationFcmResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PUT/guardian/factors/push-notification/providers/fcmv1Overwrite FCMV1 configuration

Request body

application/json — SetGuardianFactorsProviderPushNotificationFcmv1RequestContent

Responses

Status	Description	Schema
`200`	FCMV1 configuration updated	`SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PATCH/guardian/factors/push-notification/providers/fcmv1Updates FCMV1 configuration

Request body

application/json — UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent

Responses

Status	Description	Schema
`200`	FCMV1 configuration updated	`UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

GET/guardian/factors/push-notification/providers/snsGet AWS SNS configuration

Responses

Status	Description	Schema
`200`	AWS SNS configuration successfully retrieved.	`GetGuardianFactorsProviderSnsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/push-notification/providers/snsConfigure AWS SNS configuration

Request body

application/json — SetGuardianFactorsProviderPushNotificationSnsRequestContent

Responses

Status	Description	Schema
`200`	AWS SNS configuration successfully updated.	`SetGuardianFactorsProviderPushNotificationSnsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PATCH/guardian/factors/push-notification/providers/snsUpdate AWS SNS configuration

Request body

application/json — UpdateGuardianFactorsProviderPushNotificationSnsRequestContent

Responses

Status	Description	Schema
`200`	AWS SNS configuration successfully updated.	`UpdateGuardianFactorsProviderPushNotificationSnsResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/factors/push-notification/selected-providerGet push notification provider

Responses

Status	Description	Schema
`200`	Returns selected push notification provider	`GetGuardianFactorsProviderPushNotificationResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PUT/guardian/factors/push-notification/selected-providerUpdate Push Notification configuration

Request body

application/json — SetGuardianFactorsProviderPushNotificationRequestContent

Responses

Status	Description	Schema
`200`	Returns selected push notification provider configuration	`SetGuardianFactorsProviderPushNotificationResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

GET/guardian/factors/sms/providers/twilioGet Twilio SMS configuration

Responses

Status	Description	Schema
`200`	Twilio SMS configuration successfully retrieved.	`GetGuardianFactorsProviderSmsTwilioResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/sms/providers/twilioUpdate Twilio SMS configuration

Request body

application/json — SetGuardianFactorsProviderSmsTwilioRequestContent

Responses

Status	Description	Schema
`200`	Twilio SMS configuration successfully updated.	`SetGuardianFactorsProviderSmsTwilioResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/factors/sms/selected-providerGet SMS configuration

Responses

Status	Description	Schema
`200`	Returns selected SMS provider configuration	`GetGuardianFactorsProviderSmsResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PUT/guardian/factors/sms/selected-providerUpdate SMS configuration

Request body

application/json — SetGuardianFactorsProviderSmsRequestContent

Responses

Status	Description	Schema
`200`	Returns selected SMS provider configuration	`SetGuardianFactorsProviderSmsResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

GET/guardian/factors/sms/templatesGet SMS enrollment and verification templates

Responses

Status	Description	Schema
`200`	SMS enrollment and verification templates successfully retrieved.	`GetGuardianFactorSmsTemplatesResponseContent`
`204`	No content.	`GetGuardianFactorSmsTemplatesResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/sms/templatesUpdate SMS enrollment and verification templates

Request body

application/json — SetGuardianFactorSmsTemplatesRequestContent

Responses

Status	Description	Schema
`200`	SMS enrollment and verification templates successfully updated.	`SetGuardianFactorSmsTemplatesResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

PUT/guardian/factors/{name}Update multi-factor authentication type

Parameters

Name	In	Required	Type
`name`	path	yes	—

Request body

application/json — SetGuardianFactorRequestContent

Responses

Status	Description	Schema
`200`	Factor updated successfully.	`SetGuardianFactorResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope.	—

GET/guardian/policiesGet multi-factor authentication policies

Responses

Status	Description	Schema
`200`	Success	`ListGuardianPoliciesResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

PUT/guardian/policiesUpdate multi-factor authentication policies

Request body

application/json — SetGuardianPoliciesRequestContent

Responses

Status	Description	Schema
`200`	Policies updated	`SetGuardianPoliciesResponseContent`
`400`	Invalid input based on schemas	—
`401`	Token has expired or signature is invalid	—
`403`	Insufficient scope	—

hooks9

GET/hooksGet hooks

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`enabled`	query	no	boolean
`fields`	query	no	string
`triggerId`	query	no	—

Responses

Status	Description	Schema
`200`	Hooks successfully retrieved.	`ListHooksResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:hooks.	—
`404`	Hook not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/hooksCreate a hook

Request body

application/json — CreateHookRequestContent

Responses

Status	Description	Schema
`201`	Hook successfully created.	`CreateHookResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:hooks.	—
`409`	Hook with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/hooks/{id}Get a hook

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string

Responses

Status	Description	Schema
`200`	Hook successfully retrieved.	`GetHookResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:hooks.	—
`404`	Hook not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/hooks/{id}Update a hook

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateHookRequestContent

Responses

Status	Description	Schema
`201`	Hook successfully created.	`UpdateHookResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:hooks.	—
`404`	The hook does not exist	—
`409`	A hook with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/hooks/{id}Delete a hook

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Hook successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:hooks.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/hooks/{id}/secretsGet hook secrets

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Hook secrets successfully retrieved.	`GetHookSecretResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:hooks.	—
`404`	Hook not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/hooks/{id}/secretsAdd hook secrets

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateHookSecretRequestContent

Responses

Status	Description	Schema
`201`	Hook secrets successfully added.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:hooks.	—
`409`	Secret with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/hooks/{id}/secretsUpdate hook secrets

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateHookSecretRequestContent

Responses

Status	Description	Schema
`201`	Hook secrets successfully updated.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:hooks.	—
`404`	Hook or secret not found.	—
`409`	Secret with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/hooks/{id}/secretsDelete hook secrets

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteHookSecretRequestContent

Responses

Status	Description	Schema
`204`	Hook secrets successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:hooks.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

jobs5

POST/jobs/users-exportsCreate export users job

Request body

application/json — CreateExportUsersRequestContent

Responses

Status	Description	Schema
`200`	Job created successfully.	`CreateExportUsersResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/jobs/users-importsCreate import users job

Request body

multipart/form-data — CreateImportUsersRequestContent

Responses

Status	Description	Schema
`202`	Job successfully created.	`CreateImportUsersResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:users.	—
`413`	Payload content length greater than maximum allowed: 512000.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	Internal error.	—

POST/jobs/verification-emailSend an email address verification email

Parameters

Name	In	Required	Type
`auth0-custom-domain`	header	no	string

Request body

application/json — CreateVerificationEmailRequestContent

Responses

Status	Description	Schema
`201`	Job successfully created.	`CreateVerificationEmailResponseContent`
`400`	Invalid request parameters. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/jobs/{id}Get a job

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Job retrieved successfully.	`GetJobResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:users.	—
`404`	Job not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/jobs/{id}/errorsGet job error details

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Job successfully retrieved.	—
`204`	The job was retrieved, but no errors were found.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: create:users	—
`404`	The job does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

keys14

GET/keys/custom-signingGet custom signing keys

Responses

Status	Description	Schema
`200`	Custom signing keys were successfully retrieved.	`GetCustomSigningKeysResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:custom_signing_keys.	—
`404`	No custom signing keys found for this tenant. Upload custom signing keys first.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/keys/custom-signingCreate or replace custom signing keys

Request body

application/json — SetCustomSigningKeysRequestContent

Responses

Status	Description	Schema
`200`	Custom signing keys were successfully created or replaced.	`SetCustomSigningKeysResponseContent`
`400`	Payload validation error.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected all of: create:custom_signing_keys,update:custom_signing_keys.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/keys/custom-signingDelete custom signing keys

Responses

Status	Description	Schema
`204`	Custom signing keys were successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:custom_signing_keys.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/keys/encryptionGet all encryption keys

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	The keys were successfully retrieved.	`ListEncryptionKeysResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:encryption_keys.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/keys/encryptionCreate the new encryption key

Request body

application/json — CreateEncryptionKeyRequestContent

Responses

Status	Description	Schema
`201`	The key was successfully created.	`CreateEncryptionKeyResponseContent`
`400`	Request body is invalid. Unsupported key "type" provided.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:encryption_keys.	—
`409`	Encryption key has already been created.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/keys/encryption/rekeyRekey the key hierarchy

Responses

Status	Description	Schema
`204`	The key hierarchy was successfully rekeyed.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected all of: create:encryption_keys update:encryption_keys.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/keys/encryption/{kid}Get the encryption key by its key id

Parameters

Name	In	Required	Type
`kid`	path	yes	string

Responses

Status	Description	Schema
`200`	The key was successfully retrieved.	`GetEncryptionKeyResponseContent`
`400`	Invalid UUID format in uri.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:encryption_keys.	—
`404`	The key does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/keys/encryption/{kid}Import the encryption key

Parameters

Name	In	Required	Type
`kid`	path	yes	string

Request body

application/json — ImportEncryptionKeyRequestContent

Responses

Status	Description	Schema
`201`	The key was successfully imported.	`ImportEncryptionKeyResponseContent`
`400`	The key ID was not found.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:encryption_keys.	—
`409`	Failed precondition. Key import not in progress or unable to find the wrapping key. Make sure you have followed all the steps to import a key.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/keys/encryption/{kid}Delete the encryption key by its key id

Parameters

Name	In	Required	Type
`kid`	path	yes	string

Responses

Status	Description	Schema
`204`	The key was successfully deleted.	—
`400`	Invalid UUID format in uri.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:encryption_keys.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/keys/encryption/{kid}/wrapping-keyCreate the public wrapping key

Parameters

Name	In	Required	Type
`kid`	path	yes	string

Responses

Status	Description	Schema
`201`	The public wrapping key was successfully created.	`CreateEncryptionKeyPublicWrappingResponseContent`
`400`	Invalid UUID format in uri.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:encryption_keys.	—
`409`	Failed precondition. Create new encryption key without the key material first.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/keys/signingGet all Application Signing Keys

Responses

Status	Description	Schema
`200`	The signing keys were retrieved.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:signing_keys	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/keys/signing/rotateRotate the Application Signing Key

Responses

Status	Description	Schema
`201`	Signing key rotated successfully.	`RotateSigningKeysResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected create:signing_keys and update:signing_keys.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/keys/signing/{kid}Get an Application Signing Key by its key id

Parameters

Name	In	Required	Type
`kid`	path	yes	string

Responses

Status	Description	Schema
`200`	The signing keys were retrieved.	`GetSigningKeysResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:signing_keys	—
`404`	Signing key not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/keys/signing/{kid}/revokeRevoke an Application Signing Key by its key id

Parameters

Name	In	Required	Type
`kid`	path	yes	string

Responses

Status	Description	Schema
`200`	Signing key revoked successfully.	`RevokedSigningKeysResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:signing_keys.	—
`404`	Signing key not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

log-streams5

GET/log-streamsGet log streams

Responses

Status	Description	Schema
`200`	Returning log streams	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:log_streams.	—
`404`	The log stream does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/log-streamsCreate a log stream

Request body

application/json — CreateLogStreamRequestContent

Responses

Status	Description	Schema
`200`	Log stream created	`CreateLogStreamResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:log_streams.	—
`409`	You have reached the maximum number of log streams for your account.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/log-streams/{id}Get log stream by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Returning log stream.	`GetLogStreamResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:log_streams.	—
`404`	The log stream does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/log-streams/{id}Update a log stream

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateLogStreamRequestContent

Responses

Status	Description	Schema
`200`	Log stream updated	`UpdateLogStreamResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:log_streams.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/log-streams/{id}Delete log stream

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The log stream was deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: delete:log_streams.	—
`404`	The log stream does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

logs2

GET/logsSearch log events

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`sort`	query	no	string
`fields`	query	no	string
`include_fields`	query	no	boolean
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer
`search`	query	no	string

Responses

Status	Description	Schema
`200`	Logs successfully retrieved.	`ListLogResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:logs, read:logs_users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/logs/{id}Get a log event by id

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Log successfully retrieved.	`GetLogResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:logs, read:logs_users.	—
`404`	Log not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

network-acls6

GET/network-aclsGet all access control list entries for a tenant

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Network access control list successfully retrieved.	`ListNetworkAclsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:network_acls.	—
`404`	Network access control list not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/network-aclsCreate Access Control List

Request body

application/json — CreateNetworkAclRequestContent

Responses

Status	Description	Schema
`201`	Network ACL successfully created.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Entitlement is not enabled for this tenant. Please upgrade your subscription to enable Tenant ACL Management.	—
`409`	A Network ACL with this priority number has already been created.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	There was an error retrieving Networks ACLs subscription settings.	—

GET/network-acls/{id}Get a specific access control list entry for a tenant

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Network access control list successfully retrieved.	`GetNetworkAclsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:network_acls.	—
`404`	Network access control list not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/network-acls/{id}Update Access Control List

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — SetNetworkAclRequestContent

Responses

Status	Description	Schema
`200`	Network ACL properties successfully updated	`SetNetworkAclsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:network_acls.	—
`404`	Network ACL not found and cannot be updated	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/network-acls/{id}Partial Update for an Access Control List

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateNetworkAclRequestContent

Responses

Status	Description	Schema
`200`	Network ACL properties successfully updated	`UpdateNetworkAclResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:network_acls.	—
`404`	Network ACL not found and cannot be updated	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/network-acls/{id}Delete Access Control List

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Network ACL successfully deleted	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Tenant ACL Management is not enabled for this tenant.	—
`404`	This ACL does not exist	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

organizations48

GET/organizationsGet organizations

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer
`sort`	query	no	string
`include_client_association_for`	query	no	string

Responses

Status	Description	Schema
`200`	Organizations successfully retrieved.	`ListOrganizationsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organizations.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizationsCreate an Organization

Request body

application/json — CreateOrganizationRequestContent

Responses

Status	Description	Schema
`201`	Organization successfully created.	`CreateOrganizationResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organizations.	—
`409`	An organization with this name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/name/{name}Get organization by name

Parameters

Name	In	Required	Type
`name`	path	yes	string

Responses

Status	Description	Schema
`200`	Organization successfully retrieved.	`GetOrganizationByNameResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organizations.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}Get organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Organization successfully retrieved.	`GetOrganizationResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organizations.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/organizations/{id}Modify an Organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateOrganizationRequestContent

Responses

Status	Description	Schema
`200`	Organization successfully updated.	`UpdateOrganizationResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:organizations.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}Delete organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	The organization was deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organizations.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/client-grantsGet client grants associated to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`audience`	query	no	string
`client_id`	query	no	string
`grant_ids`	query	no	array
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Client grants successfully retrieved.	`ListOrganizationClientGrantsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_client_grants.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/client-grantsAssociate a client grant with an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AssociateOrganizationClientGrantRequestContent

Responses

Status	Description	Schema
`201`	Client Grant successfully associated with Organization.	`AssociateOrganizationClientGrantResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_client_grants.	—
`404`	The grant does not exist.	—
`409`	The client grant has already been added to this organization.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}/client-grants/{grant_id}Remove a client grant from an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`grant_id`	path	yes	string

Responses

Status	Description	Schema
`204`	The Client Grant was removed from the Organization.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_client_grants.	—
`404`	No organization found by that id.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/clientsList organization client associations

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Organization clients successfully retrieved.	`ListOrganizationClientsResponseContent`
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`429`	—	—

POST/organizations/{id}/clientsAssociate clients with an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateOrganizationClientsRequestContent

Responses

Status	Description	Schema
`201`	Organization clients successfully associated.	`CreateOrganizationClientsResponseContent`
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`409`	—	—
`429`	—	—

DELETE/organizations/{id}/clientsRemove client associations from an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteOrganizationClientsRequestContent

Responses

Status	Description	Schema
`204`	Organization clients successfully disassociated.	—
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`429`	—	—

GET/organizations/{id}/clients/{client_id}Get an organization client association

Parameters

Name	In	Required	Type
`id`	path	yes	string
`client_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Organization client association successfully retrieved.	`GetOrganizationClientResponseContent`
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`429`	—	—

PATCH/organizations/{id}/clients/{client_id}Update an organization client association

Parameters

Name	In	Required	Type
`id`	path	yes	string
`client_id`	path	yes	string

Request body

application/json — UpdateOrganizationClientRequestContent

Responses

Status	Description	Schema
`200`	Organization client successfully updated.	`UpdateOrganizationClientResponseContent`
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`429`	—	—

GET/organizations/{id}/connectionsGet connections associated with an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`is_enabled`	query	no	boolean

Responses

Status	Description	Schema
`200`	Connections successfully retrieved.	`ListOrganizationAllConnectionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_connections.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/connectionsAdds a connection to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateOrganizationAllConnectionRequestContent

Responses

Status	Description	Schema
`201`	Connection successfully created.	`CreateOrganizationAllConnectionResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_connections.	—
`404`	The organization does not exist.	—
`409`	The organization connection already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/connections/{connection_id}Get a specific connection associated with an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`connection_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Connection successfully retrieved.	`GetOrganizationAllConnectionResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_connections.	—
`404`	The organization does not exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/organizations/{id}/connections/{connection_id}Update a connection for an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`connection_id`	path	yes	string

Request body

application/json — UpdateOrganizationAllConnectionRequestContent

Responses

Status	Description	Schema
`200`	Connection successfully updated.	`UpdateOrganizationAllConnectionResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:organization_connections.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}/connections/{connection_id}Delete a connection from an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`connection_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Connection successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_connections.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/discovery-domainsRetrieve all organization discovery domains

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Organization discovery domains retrieved successfully.	`ListOrganizationDiscoveryDomainsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_discovery_domains.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/discovery-domainsCreate an organization discovery domain

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateOrganizationDiscoveryDomainRequestContent

Responses

Status	Description	Schema
`201`	Organization discovery domain successfully created.	`CreateOrganizationDiscoveryDomainResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_discovery_domains.	—
`404`	Organization not found.	—
`409`	An organization discovery domain with this domain is already registered to this organization.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/discovery-domains/name/{discovery_domain}Retrieve an organization discovery domain by domain name

Parameters

Name	In	Required	Type
`id`	path	yes	string
`discovery_domain`	path	yes	string

Responses

Status	Description	Schema
`200`	Organization discovery domain successfully retrieved.	`GetOrganizationDiscoveryDomainByNameResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_discovery_domains.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/discovery-domains/{discovery_domain_id}Retrieve an organization discovery domain by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`discovery_domain_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Organization discovery domain successfully retrieved.	`GetOrganizationDiscoveryDomainResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_discovery_domains.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/organizations/{id}/discovery-domains/{discovery_domain_id}Update an organization discovery domain

Parameters

Name	In	Required	Type
`id`	path	yes	string
`discovery_domain_id`	path	yes	string

Request body

application/json — UpdateOrganizationDiscoveryDomainRequestContent

Responses

Status	Description	Schema
`200`	Organization discovery domain successfully updated.	`UpdateOrganizationDiscoveryDomainResponseContent`
`400`	Invalid Request Body.	—
`404`	Organization not found.	—

DELETE/organizations/{id}/discovery-domains/{discovery_domain_id}Delete an organization discovery domain

Parameters

Name	In	Required	Type
`id`	path	yes	string
`discovery_domain_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Organization discovery domain successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_discovery_domains.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/enabled_connectionsGet connections enabled for an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Connections successfully retrieved.	`ListOrganizationConnectionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_connections.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/enabled_connectionsAdd connections to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AddOrganizationConnectionRequestContent

Responses

Status	Description	Schema
`201`	Organization connection successfully added.	`AddOrganizationConnectionResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_connections.	—
`404`	The organization does not exist.	—
`409`	The organization connection already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/enabled_connections/{connectionId}Get an enabled connection for an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`connectionId`	path	yes	string

Responses

Status	Description	Schema
`200`	Connection successfully retrieved.	`GetOrganizationConnectionResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_connections.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/organizations/{id}/enabled_connections/{connectionId}Update the Connection of an Organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`connectionId`	path	yes	string

Request body

application/json — UpdateOrganizationConnectionRequestContent

Responses

Status	Description	Schema
`200`	Organization connection successfully updated.	`UpdateOrganizationConnectionResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:organization_connections.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}/enabled_connections/{connectionId}Delete connections from an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`connectionId`	path	yes	string

Responses

Status	Description	Schema
`204`	Connection successfully removed from organization.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_connections.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/invitationsGet invitations to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`fields`	query	no	string
`include_fields`	query	no	boolean
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	Invitations successfully retrieved.	`ListOrganizationInvitationsResponseContent`
`400`	Requesting page exceeds the allowed maximum of 1000 records	—
`401`	Client is not global.	—
`403`	Insufficient scope; expected any of: read:organization_invitations.	—
`404`	No organization found by that id.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/invitationsCreate invitations to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`auth0-custom-domain`	header	no	string

Request body

application/json — CreateOrganizationInvitationRequestContent

Responses

Status	Description	Schema
`200`	Invitation successfully created.	`CreateOrganizationInvitationResponseContent`
`400`	A default login route is required to generate the invitation url. For more information, see https://auth0.com/docs/universal-login/configure-default-login-routes	—
`401`	Client is not global.	—
`403`	Insufficient scope; expected any of: create:organization_invitations.	—
`404`	No organization found by that id.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/invitations/{invitation_id}Get a specific invitation to an Organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`invitation_id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Invitation successfully retrieved.	`GetOrganizationInvitationResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Client is not global.	—
`403`	Insufficient scope; expected any of: read:organization_invitations.	—
`404`	No organization found by that id.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}/invitations/{invitation_id}Delete an invitation to an Organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`invitation_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Invitation successfully deleted.	—
`401`	Client is not global.	—
`403`	Insufficient scope; expected any of: delete:organization_invitations.	—
`404`	No organization found by that id.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/membersGet members who belong to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Members successfully retrieved.	`ListOrganizationMembersResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_members, read:organization_member_roles.	—
`404`	The organization does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/membersAdd members to an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateOrganizationMemberRequestContent

Responses

Status	Description	Schema
`204`	Members successfully added to organization.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_members.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}/membersDelete members from an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteOrganizationMembersRequestContent

Responses

Status	Description	Schema
`204`	Users successfully removed from organization.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_members.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/members/{user_id}/effective-rolesList organization member effective roles.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Organization member's effective roles successfully retrieved.	`ListOrganizationMemberEffectiveRolesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_member_effective_roles.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/members/{user_id}/effective-roles/sources/groupsList organization member role group sources.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer
`role_id`	query	yes	string

Responses

Status	Description	Schema
`200`	Organization member role source groups successfully retrieved.	`ListOrganizationMemberRoleSourceGroupsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_member_role_source_groups.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/members/{user_id}/rolesGet user roles assigned to an Organization member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Roles successfully retrieved.	`ListOrganizationMemberRolesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_member_roles.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{id}/members/{user_id}/rolesAssign user roles to an Organization member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	string

Request body

application/json — AssignOrganizationMemberRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully associated with user.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_member_roles.	—
`409`	No more roles can be assigned to this organization member.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{id}/members/{user_id}/rolesDelete user roles from an Organization member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	string

Request body

application/json — DeleteOrganizationMemberRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully removed from organization member.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_member_roles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{id}/roles/{role_id}/membersList the members assigned to a role in the context of an organization

Parameters

Name	In	Required	Type
`id`	path	yes	string
`role_id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	—	—
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`429`	—	—

GET/organizations/{organization_id}/groupsLists the groups that are assigned to the organization.

Parameters

Name	In	Required	Type
`organization_id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Organization groups successfully retrieved.	`ListOrganizationGroupsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_groups.	—
`404`	Organization not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{organization_id}/groups/{group_id}/rolesLists the roles assigned to a group in the context of an organization.

Parameters

Name	In	Required	Type
`organization_id`	path	yes	string
`group_id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Organization group roles successfully retrieved.	`ListOrganizationGroupRolesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:organization_group_roles.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/organizations/{organization_id}/groups/{group_id}/rolesAssigns roles to a group in an organization context.

Parameters

Name	In	Required	Type
`organization_id`	path	yes	string
`group_id`	path	yes	string

Request body

application/json — CreateOrganizationGroupRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully assigned to organization group.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:organization_group_roles.	—
`404`	Group not found.	—
`409`	No more roles can be assigned to this organization group.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/organizations/{organization_id}/groups/{group_id}/rolesRemoves roles assigned to a group in an organization context.

Parameters

Name	In	Required	Type
`organization_id`	path	yes	string
`group_id`	path	yes	string

Request body

application/json — DeleteOrganizationGroupRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully removed from organization group.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:organization_group_roles.	—
`404`	Group not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/organizations/{organization_id}/roles/{role_id}/groupsList the groups assigned to a role in the context of an organization

Responses

Status	Description	Schema
`200`	Organization role groups successfully retrieved.	`ListOrganizationRoleGroupsResponseContent`
`400`	—	—
`401`	—	—
`403`	—	—
`404`	—	—
`429`	—	—

prompts10

GET/promptsGet prompt settings

Responses

Status	Description	Schema
`200`	Prompt settings successfully retrieved.	`GetSettingsResponseContent`
`401`	Invalid token.	—
`403`	The specified client cannot perform the requested operation.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/promptsUpdate prompt settings

Request body

application/json — UpdateSettingsRequestContent

Responses

Status	Description	Schema
`200`	Prompts settings successfully updated.	`UpdateSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:prompts.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/prompts/renderingGet render setting configurations for all screens

Parameters

Name	In	Required	Type
`fields`	query	no	string
`include_fields`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`prompt`	query	no	string
`screen`	query	no	string
`rendering_mode`	query	no	—

Responses

Status	Description	Schema
`200`	ACUL settings successfully retrieved.	`ListAculsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`402`	A paid subscription is required to use Advanced Customizations.	—
`403`	Insufficient scope; expected any of: read:prompts.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/prompts/renderingUpdate render settings for multiple screens

Request body

application/json — BulkUpdateAculRequestContent

Responses

Status	Description	Schema
`200`	ACUL settings successfully updated.	`BulkUpdateAculResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`402`	A paid subscription is required to use Advanced Customizations.	—
`403`	Insufficient scope; expected any of: update:prompts.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/prompts/{prompt}/custom-text/{language}Get custom text for a prompt

Parameters

Name	In	Required	Type
`prompt`	path	yes	—
`language`	path	yes	—

Responses

Status	Description	Schema
`200`	Prompt dictionaries successfully retrieved.	`GetCustomTextsByLanguageResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:prompts.	—
`404`	The prompt does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/prompts/{prompt}/custom-text/{language}Set custom text for a specific prompt

Parameters

Name	In	Required	Type
`prompt`	path	yes	—
`language`	path	yes	—

Request body

application/json — SetsCustomTextsByLanguageRequestContent

Responses

Status	Description	Schema
`200`	Prompt dictionaries successfully updated.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:prompts.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/prompts/{prompt}/partialsGet partials for a prompt

Parameters

Name	In	Required	Type
`prompt`	path	yes	—

Responses

Status	Description	Schema
`200`	Prompt partials successfully retrieved.	`GetPartialsResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:prompts.	—
`404`	The prompt does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/prompts/{prompt}/partialsSet partials for a prompt

Parameters

Name	In	Required	Type
`prompt`	path	yes	—

Request body

application/json — SetPartialsRequestContent

Responses

Status	Description	Schema
`200`	Template partials successfully updated.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:prompts.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/prompts/{prompt}/screen/{screen}/renderingGet render settings for a screen

Parameters

Name	In	Required	Type
`prompt`	path	yes	—
`screen`	path	yes	—

Responses

Status	Description	Schema
`200`	ACUL settings successfully retrieved.	`GetAculResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`402`	A paid subscription is required to use Advanced Customizations.	—
`403`	Insufficient scope; expected any of: read:prompts.	—
`404`	The prompt does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/prompts/{prompt}/screen/{screen}/renderingUpdate render settings for a screen

Parameters

Name	In	Required	Type
`prompt`	path	yes	—
`screen`	path	yes	—

Request body

application/json — UpdateAculRequestContent

Responses

Status	Description	Schema
`200`	ACUL settings successfully updated.	`UpdateAculResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`402`	A paid subscription is required to use Advanced Customizations.	—
`403`	Insufficient scope; expected any of: update:prompts.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

rate-limit-policies5

GET/rate-limit-policiesGet rate limit policies

Parameters

Name	In	Required	Type
`resource`	query	no	—
`consumer`	query	no	—
`consumer_selector`	query	no	string
`take`	query	no	integer
`from`	query	no	string

Responses

Status	Description	Schema
`200`	Rate limit policies retrieved successfully.	`ListRateLimitPoliciesPaginatedResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:rate_limit_policies.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/rate-limit-policiesCreate a rate limit policy

Request body

application/json — CreateRateLimitPolicyRequestContent

Responses

Status	Description	Schema
`201`	Rate limit policy successfully created.	`CreateRateLimitPolicyResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:rate_limit_policies.	—
`409`	A rate limit policy with the same resource, consumer, and consumer_selector already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/rate-limit-policies/{id}Get a rate limit policy

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Rate limit policy retrieved successfully.	`GetRateLimitPolicyResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:rate_limit_policies.	—
`404`	The rate limit policy does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/rate-limit-policies/{id}Update a rate limit policy

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — PatchRateLimitPolicyRequestContent

Responses

Status	Description	Schema
`200`	Rate limit policy successfully updated.	`UpdateRateLimitPolicyResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:rate_limit_policies.	—
`404`	The rate limit policy does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/rate-limit-policies/{id}Delete a rate limit policy

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Rate limit policy successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:rate_limit_policies.	—
`404`	The rate limit policy does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

refresh-tokens5

GET/refresh-tokensGet refresh tokens

Parameters

Name	In	Required	Type
`user_id`	query	yes	string
`client_id`	query	no	string
`from`	query	no	string
`take`	query	no	integer
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	The refresh tokens were retrieved.	`GetRefreshTokensPaginatedResponseContent`
`400`	Missing required 'user_id' parameter.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:refresh_tokens	—
`404`	User not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/refresh-tokens/revokeRevoke refresh tokens

Request body

application/json — RevokeRefreshTokensRequestContent

Responses

Status	Description	Schema
`202`	Refresh token revocation request accepted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:refresh_tokens	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/refresh-tokens/{id}Get a refresh token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The refresh token was retrieved	`GetRefreshTokenResponseContent`
`400`	API doesn't support Online Refresh Tokens	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:refresh_tokens	—
`404`	The refresh token does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/refresh-tokens/{id}Update a refresh token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateRefreshTokenRequestContent

Responses

Status	Description	Schema
`200`	Refresh token successfully updated.	`UpdateRefreshTokenResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:refresh_tokens.	—
`404`	The refresh token does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/refresh-tokens/{id}Delete a refresh token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Refresh token deletion request accepted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:refresh_tokens	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

resource-servers5

GET/resource-serversGet resource servers

Parameters

Name	In	Required	Type
`identifiers`	query	no	array
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Resource servers successfully retrieved.	`ListResourceServerResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:resource_servers.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/resource-serversCreate a resource server

Request body

application/json — CreateResourceServerRequestContent

Responses

Status	Description	Schema
`201`	Resource server successfully created.	`CreateResourceServerResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:resource_servers.	—
`409`	A resource server with the same identifier already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/resource-servers/{id}Get a resource server

Parameters

Name	In	Required	Type
`id`	path	yes	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Resource server successfully retrieved.	`GetResourceServerResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:resource_servers.	—
`404`	Resource server not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/resource-servers/{id}Update a resource server

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateResourceServerRequestContent

Responses

Status	Description	Schema
`201`	Resource server successfully updated.	`UpdateResourceServerResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:resource_servers.	—
`409`	A resource server with the same identifier already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/resource-servers/{id}Delete a resource server

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Resource server successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:resource_servers.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

risk-assessments4

GET/risk-assessments/settingsGet risk assessment settings

Responses

Status	Description	Schema
`200`	Returning risk assessment settings for the tenant	`GetRiskAssessmentsSettingsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:attack_protection.	—
`404`	The tenant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/risk-assessments/settingsUpdate risk assessment settings

Request body

application/json — UpdateRiskAssessmentsSettingsRequestContent

Responses

Status	Description	Schema
`200`	Returning risk assessment settings for the tenant	`UpdateRiskAssessmentsSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:attack_protection.	—
`404`	The tenant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/risk-assessments/settings/new-deviceGet new device assessor

Responses

Status	Description	Schema
`200`	Returning risk assessment settings for new devices	`GetRiskAssessmentsSettingsNewDeviceResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:attack_protection.	—
`404`	The tenant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/risk-assessments/settings/new-deviceUpdate new device assessor

Request body

application/json — UpdateRiskAssessmentsSettingsNewDeviceRequestContent

Responses

Status	Description	Schema
`200`	Returning risk assessment settings for new devices	`UpdateRiskAssessmentsSettingsNewDeviceResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:attack_protection.	—
`404`	The tenant does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

roles13

GET/rolesGet roles

Parameters

Name	In	Required	Type
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean
`name_filter`	query	no	string
`type`	query	no	—
`owner_id`	query	no	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Roles successfully retrieved.	`ListRolesResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: read:roles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/rolesCreate a role

Request body

application/json — CreateRoleRequestContent

Responses

Status	Description	Schema
`200`	Role successfully created.	`CreateRoleResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: create:roles.	—
`409`	The role already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/roles/{id}Get a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Role successfully retrieved.	`GetRoleResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: read:roles.	—
`404`	Role not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/roles/{id}Update a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateRoleRequestContent

Responses

Status	Description	Schema
`200`	Role successfully updated.	`UpdateRoleResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:roles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/roles/{id}Delete a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Role successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:roles.	—
`404`	Role not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/roles/{id}/groupsGet a role's groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Role's groups successfully retrieved.	`ListRoleGroupsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:group_roles.	—
`404`	The role does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/roles/{id}/groupsAssign groups to a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AssignRoleGroupsRequestContent

Responses

Status	Description	Schema
`204`	Groups successfully assigned to role.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:group_roles.	—
`404`	Role not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/roles/{id}/groupsRemove groups from a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteRoleGroupsRequestContent

Responses

Status	Description	Schema
`204`	Groups successfully removed from role.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:group_roles.	—
`404`	The role does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/roles/{id}/permissionsGet permissions granted by role

Parameters

Name	In	Required	Type
`id`	path	yes	string
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Role permissions successfully retrieved.	`ListRolePermissionsResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: read:roles.	—
`404`	Role not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/roles/{id}/permissionsAssociate permissions with a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AddRolePermissionsRequestContent

Responses

Status	Description	Schema
`201`	Role permissions updated.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:roles.	—
`404`	The role does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/roles/{id}/permissionsRemove permissions from a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteRolePermissionsRequestContent

Responses

Status	Description	Schema
`200`	Role permissions successfully updated.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:roles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/roles/{id}/usersGet a role's users

Parameters

Name	In	Required	Type
`id`	path	yes	string
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Role users successfully retrieved.	`ListRoleUsersResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected all of: read:users, read:roles.	—
`404`	Role not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/roles/{id}/usersAssign users to a role

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AssignRoleUsersRequestContent

Responses

Status	Description	Schema
`200`	Role users successfully updated.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:roles.	—
`404`	Role not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

rules5

GET/rulesGet rules

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`enabled`	query	no	boolean
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Rules successfully retrieved.	`ListRulesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:rules.	—
`404`	Rule not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/rulesCreate a rule

Request body

application/json — CreateRuleRequestContent

Responses

Status	Description	Schema
`201`	Rule successfully created.	`CreateRuleResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:rules.	—
`409`	A rule with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/rules/{id}Get a rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Rule successfully retrieved.	`GetRuleResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:rules.	—
`404`	Rule not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/rules/{id}Update a rule

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateRuleRequestContent

Responses

Status	Description	Schema
`200`	Rule successfully updated.	`UpdateRuleResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:rules.	—
`404`	Rule not found.	—
`409`	A rule with the same name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/rules/{id}Delete a rule

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Rule successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:rules.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

rules-configs3

GET/rules-configsRetrieve config variable keys for rules (get_rules-configs)

Responses

Status	Description	Schema
`200`	Rules config keys successfully retrieved.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:rules_configs.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/rules-configs/{key}Set rules config for a given key

Parameters

Name	In	Required	Type
`key`	path	yes	string

Request body

application/json — SetRulesConfigRequestContent

Responses

Status	Description	Schema
`200`	Rules config variable successfully set.	`SetRulesConfigResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:rules_configs.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/rules-configs/{key}Delete rules config for a given key

Parameters

Name	In	Required	Type
`key`	path	yes	string

Responses

Status	Description	Schema
`204`	Rules config variable successfully removed.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:rules_configs.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

self-service-profiles9

GET/self-service-profilesGet self-service profiles

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	List of existing profiles.	`ListSelfServiceProfilesResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:self_service_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	Internal error.	—

POST/self-service-profilesCreate a self-service profile

Request body

application/json — CreateSelfServiceProfileRequestContent

Responses

Status	Description	Schema
`201`	Self-service profile successfully created.	`CreateSelfServiceProfileResponseContent`
`400`	Invalid Request Body.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: create:self_service_profiles.	—
`409`	No more profiles can be created for this tenant.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	Internal error.	—

GET/self-service-profiles/{id}Get a self-service profile by Id

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Record for existing self-service profile.	`GetSelfServiceProfileResponseContent`
`400`	Invalid Request.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:self_service_profiles.	—
`404`	Self-service profile not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	Internal error.	—

PATCH/self-service-profiles/{id}Update a self-service profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateSelfServiceProfileRequestContent

Responses

Status	Description	Schema
`200`	Self-service profile successfully updated.	`UpdateSelfServiceProfileResponseContent`
`400`	Invalid Request.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: update:self_service_profiles.	—
`404`	Self-service profile not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	Internal error.	—

DELETE/self-service-profiles/{id}Delete a self-service profile by Id

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Self-service profile successfully deleted.	—
`400`	Invalid Request.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected: delete:self_service_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`500`	Internal error.	—

GET/self-service-profiles/{id}/custom-text/{language}/{page}Get custom text for a self-service profile

Parameters

Name	In	Required	Type
`id`	path	yes	string
`language`	path	yes	—
`page`	path	yes	—

Responses

Status	Description	Schema
`200`	Retrieved custom text.	`ListSelfServiceProfileCustomTextResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:self_service_profile_custom_texts.	—
`404`	Self-service profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/self-service-profiles/{id}/custom-text/{language}/{page}Set custom text for a self-service profile

Parameters

Name	In	Required	Type
`id`	path	yes	string
`language`	path	yes	—
`page`	path	yes	—

Request body

application/json — SetSelfServiceProfileCustomTextRequestContent

Responses

Status	Description	Schema
`200`	Updated custom text.	`SetSelfServiceProfileCustomTextResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:self_service_profile_custom_texts.	—
`404`	Self-service profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/self-service-profiles/{id}/sso-ticketCreate an access ticket to initiate the Self-Service Enterprise Configuration flow

Parameters

Name	In	Required	Type
`id`	path	yes	string
`auth0-custom-domain`	header	no	string

Request body

application/json — CreateSelfServiceProfileSsoTicketRequestContent

Responses

Status	Description	Schema
`201`	Self-Service Enterprise Configuration Access Ticket successfully created.	`CreateSelfServiceProfileSsoTicketResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:sso_access_tickets.	—
`409`	A connection with this name already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/self-service-profiles/{profileId}/sso-ticket/{id}/revokeRevoke a Self-Service Enterprise Configuration access ticket

Parameters

Name	In	Required	Type
`profileId`	path	yes	string
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Self-Service Enterprise Configuration Access Ticket revocation request accepted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:sso_access_tickets.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

sessions4

GET/sessions/{id}Get session

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The session was retrieved	`GetSessionResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:sessions	—
`404`	The session does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/sessions/{id}Update session

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateSessionRequestContent

Responses

Status	Description	Schema
`200`	Session successfully updated.	`UpdateSessionResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:sessions.	—
`404`	The session does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/sessions/{id}Delete session

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Session deletion request accepted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:sessions	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/sessions/{id}/revokeRevokes a session

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Session deletion request accepted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:sessions	—
`404`	The session does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

stats2

GET/stats/active-usersGet active users count

Responses

Status	Description	Schema
`200`	Number of active users successfully retrieved.	`GetActiveUsersCountStatsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:stats.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/stats/dailyGet daily stats

Parameters

Name	In	Required	Type
`from`	query	no	string
`to`	query	no	string

Responses

Status	Description	Schema
`200`	Daily stats successfully retrieved.	—
`400`	—	—
`401`	—	—
`403`	—	—
`429`	—	—

supplemental-signals2

GET/supplemental-signalsGet the supplemental signals configuration for a tenant

Responses

Status	Description	Schema
`200`	Supplemental Signals configuration successfully retrieved.	`GetSupplementalSignalsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:attack_protection.	—
`404`	Supplemental Signals configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/supplemental-signalsUpdate the supplemental signals configuration for a tenant

Request body

application/json — UpdateSupplementalSignalsRequestContent

Responses

Status	Description	Schema
`200`	Supplemental Signals configuration successfully updated.	`PatchSupplementalSignalsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:attack_protection.	—
`404`	Supplemental Signals configuration not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

tenants2

GET/tenants/settingsGet tenant settings

Parameters

Name	In	Required	Type
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	Tenant settings successfully retrieved.	`GetTenantSettingsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	The specified client cannot perform the requested operation.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/tenants/settingsUpdate tenant settings

Request body

application/json — UpdateTenantSettingsRequestContent

Responses

Status	Description	Schema
`200`	Tenant settings successfully updated.	`UpdateTenantSettingsResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:tenant_settings.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

tickets2

POST/tickets/email-verificationCreate an email verification ticket

Parameters

Name	In	Required	Type
`auth0-custom-domain`	header	no	string

Request body

application/json — VerifyEmailTicketRequestContent

Responses

Status	Description	Schema
`201`	Ticket successfully created.	`VerifyEmailTicketResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/tickets/password-changeCreate a password change ticket

Parameters

Name	In	Required	Type
`auth0-custom-domain`	header	no	string

Request body

application/json — ChangePasswordTicketRequestContent

Responses

Status	Description	Schema
`201`	Ticket successfully created.	`ChangePasswordTicketResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

token-exchange-profiles5

GET/token-exchange-profilesGet token exchange profiles

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Token Exchange Profile successfully retrieved.	`ListTokenExchangeProfileResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:token_exchange_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/token-exchange-profilesCreate a token exchange profile

Request body

application/json — CreateTokenExchangeProfileRequestContent

Responses

Status	Description	Schema
`201`	Token exchange profile successfully created.	`CreateTokenExchangeProfileResponseContent`
`400`	Type field must be custom	—
`401`	Invalid token.	—
`403`	You reached the limit of entities of this type for this tenant.	—
`409`	subject_token_type already exists for tenant	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/token-exchange-profiles/{id}Get a token exchange profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Token Exchange Profile successfully retrieved.	`GetTokenExchangeProfileResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:token_exchange_profiles.	—
`404`	Token Exchange Profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/token-exchange-profiles/{id}Update an existing token exchange profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateTokenExchangeProfileRequestContent

Responses

Status	Description	Schema
`200`	Token exchange profile successfully updated.	—
`400`	subject_token_type already exists for tenant	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:token_exchange_profiles.	—
`404`	Token exchange profile not found.	—
`409`	Token exchange profile with the same subject_token_type already exists	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/token-exchange-profiles/{id}Delete a token exchange profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Token Exchange Profile successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:token_exchange_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

user-attribute-profiles7

GET/user-attribute-profilesGet User Attribute Profiles

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	User Attribute Profiles successfully retrieved.	`ListUserAttributeProfilesPaginatedResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_attribute_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/user-attribute-profilesPost User Attribute Profile

Request body

application/json — CreateUserAttributeProfileRequestContent

Responses

Status	Description	Schema
`201`	User attribute successfully created.	`CreateUserAttributeProfileResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: create:user_attribute_profiles.	—
`409`	User attribute profile conflict.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/user-attribute-profiles/templatesGet User Attribute Profile Templates

Responses

Status	Description	Schema
`200`	User Attribute Profile Templates successfully retrieved.	`ListUserAttributeProfileTemplateResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_attribute_profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/user-attribute-profiles/templates/{id}Get User Attribute Profile Template

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	User Attribute Profile Template successfully retrieved.	`GetUserAttributeProfileTemplateResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_attribute_profiles.	—
`404`	User attribute profile template not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/user-attribute-profiles/{id}Get User Attribute Profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Record for existing user attribute profile.	`GetUserAttributeProfileResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user-attribute-profiles.	—
`404`	User attribute profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/user-attribute-profiles/{id}Modify a user attribute profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateUserAttributeProfileRequestContent

Responses

Status	Description	Schema
`200`	User attribute profile successfully updated.	`UpdateUserAttributeProfileResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:user_attribute_profiles.	—
`404`	User attribute profile not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/user-attribute-profiles/{id}Delete User Attribute Profile

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	User attribute profile successfully deleted.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:user-attribute-profiles.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

user-blocks4

GET/user-blocksGet blocks by identifier

Parameters

Name	In	Required	Type
`identifier`	query	yes	string
`consider_brute_force_enablement`	query	no	boolean

Responses

Status	Description	Schema
`200`	User successfully retrieved.	`ListUserBlocksByIdentifierResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/user-blocksUnblock by identifier

Parameters

Name	In	Required	Type
`identifier`	query	yes	string

Responses

Status	Description	Schema
`204`	User successfully unblocked.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Some fields cannot be read with the permissions granted by the bearer token scopes. The message will vary depending on the fields and the scopes.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/user-blocks/{id}Get a user's blocks

Parameters

Name	In	Required	Type
`id`	path	yes	string
`consider_brute_force_enablement`	query	no	boolean

Responses

Status	Description	Schema
`200`	User block successfully retrieved.	`ListUserBlocksResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/user-blocks/{id}Unblock a user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	User successfully unblocked.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

users39

GET/usersList or Search Users

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`sort`	query	no	string
`connection`	query	no	string
`fields`	query	no	string
`include_fields`	query	no	boolean
`q`	query	no	string
`search_engine`	query	no	—
`primary_order`	query	no	boolean

Responses

Status	Description	Schema
`200`	Users successfully retrieved.	`ListUsersResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Client is not global.	—
`403`	Insufficient scope, expected any of: read:users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—
`503`	The query exceeded the timeout. Please try refining your search criteria. See https://auth0.com/docs/best-practices/search-best-practices.	—

POST/usersCreate a User

Parameters

Name	In	Required	Type
`auth0-custom-domain`	header	no	string

Request body

application/json — CreateUserRequestContent

Responses

Status	Description	Schema
`201`	User successfully created.	`CreateUserResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: create:users.	—
`409`	User already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}Get a User

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean

Responses

Status	Description	Schema
`200`	User successfully retrieved.	`GetUserResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/users/{id}Update a User

Parameters

Name	In	Required	Type
`id`	path	yes	string
`auth0-custom-domain`	header	no	string

Request body

application/json — UpdateUserRequestContent

Responses

Status	Description	Schema
`200`	User successfully updated.	`UpdateUserResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}Delete a User

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	User successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/authentication-methodsGet a list of authentication methods

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	The authentication methods for the user were retrieved.	`ListUserAuthenticationMethodsResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/authentication-methodsCreates an authentication method for a given user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateUserAuthenticationMethodRequestContent

Responses

Status	Description	Schema
`201`	Authentication method created.	`CreateUserAuthenticationMethodResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	You reached the limit of entities of this type for this user.	—
`404`	The user does not exist.	—
`409`	Authentication method already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PUT/users/{id}/authentication-methodsUpdate all authentication methods by replacing them with the given ones

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — SetUserAuthenticationMethodsRequestContent

Responses

Status	Description	Schema
`200`	All authentication methods successfully updated.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`409`	Authentication method already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}/authentication-methodsDelete all authentication methods for the given user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Authentication methods successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/authentication-methods/{authentication_method_id}Get an authentication method by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`authentication_method_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Authentication method retrieved.	`GetUserAuthenticationMethodResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/users/{id}/authentication-methods/{authentication_method_id}Update an authentication method

Parameters

Name	In	Required	Type
`id`	path	yes	string
`authentication_method_id`	path	yes	string

Request body

application/json — UpdateUserAuthenticationMethodRequestContent

Responses

Status	Description	Schema
`200`	Authentication method updated.	`UpdateUserAuthenticationMethodResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}/authentication-methods/{authentication_method_id}Delete an authentication method by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`authentication_method_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Authentication method successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}/authenticatorsDelete All Authenticators

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	All authenticators successfully deleted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/connected-accountsGet a User's Connected Accounts

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Connected accounts successfully retrieved.	`ListUserConnectedAccountsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:users.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/effective-permissionsLists the permissions assigned to a user directly or through roles or groups.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer
`resource_server_identifier`	query	yes	string

Responses

Status	Description	Schema
`200`	User's effective permissions successfully retrieved.	`ListUserEffectivePermissionsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_effective_permissions.	—
`404`	User does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/effective-permissions/sources/effective-rolesLists the roles which grant the user a given permission (whether directly or through groups).

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer
`resource_server_identifier`	query	yes	string
`permission_name`	query	yes	string

Responses

Status	Description	Schema
`200`	User's effective permission role sources successfully retrieved.	`ListUserEffectivePermissionRoleSourcesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_permission_source_roles.	—
`404`	User does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/effective-rolesLists the roles for a user with sources: directly assigned or through group membership.

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	User's effective roles successfully retrieved.	`ListUserEffectiveRolesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_effective_roles.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/effective-roles/sources/groupsGet a user's role source groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`role_id`	query	yes	string
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	User's role source groups successfully retrieved.	`ListUserRoleSourceGroupsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:user_role_source_groups.	—
`404`	The role does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/enrollmentsGet the First Confirmed Multi-factor Authentication (MFA) Enrollment

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Enrollments successfully retrieved.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/groupsGet user's groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`fields`	query	no	string
`include_fields`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Groups successfully retrieved.	`GetUserGroupsResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:groups.	—
`404`	Not Found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/identitiesLink a User Account

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — LinkUserIdentityRequestContent

Responses

Status	Description	Schema
`201`	Identity successfully added.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:users, update:current_user_identities.	—
`409`	Specified identity already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}/identities/{provider}/{user_id}Unlink a User Identity

Parameters

Name	In	Required	Type
`id`	path	yes	string
`provider`	path	yes	—
`user_id`	path	yes	string

Responses

Status	Description	Schema
`200`	User identity successfully unlinked.	`DeleteUserIdentityResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:users, update:current_user_identities.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/logsGet user's log events

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`sort`	query	no	string
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Logs successfully retrieved.	`UserListLogResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:logs, read:logs_users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/multifactor/actions/invalidate-remember-browserInvalidate All Remembered Browsers for Multi-factor Authentication (MFA)

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Remembered browsers for MFA invalidated.	—
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope; expected: update:users.	—

DELETE/users/{id}/multifactor/{provider}Delete a User's Multi-factor Provider

Parameters

Name	In	Required	Type
`id`	path	yes	string
`provider`	path	yes	—

Responses

Status	Description	Schema
`204`	Multi-factor provider successfully deleted for user.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/organizationsList user's organizations

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Organizations successfully retrieved.	`ListUserOrganizationsResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:users, read:organizations.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/permissionsGet a User's Permissions

Parameters

Name	In	Required	Type
`id`	path	yes	string
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Permissions successfully retrieved.	`ListUserPermissionsResponseContent`
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: read:users.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/permissionsAssign Permissions to a User

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — CreateUserPermissionsRequestContent

Responses

Status	Description	Schema
`201`	Permissions assigned to user.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:users.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}/permissionsRemove Permissions from a User

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteUserPermissionsRequestContent

Responses

Status	Description	Schema
`204`	User permissions removed.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: update:users.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/recovery-code-regenerationGenerate New Multi-factor Authentication (MFA) Recovery Code

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	New recovery code successfully generated.	`RegenerateUsersRecoveryCodeResponseContent`
`400`	Invalid input based on schemas.	—
`401`	Token has expired or signature is invalid.	—
`403`	Insufficient scope; expected: update:users.	—
`404`	Enrollment not found.	—

POST/users/{id}/revoke-accessRevokes selected resources from a user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — RevokeUserAccessRequestContent

Responses

Status	Description	Schema
`202`	Session deletion request accepted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:sessions	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/risk-assessments/clearClear risk assessment assessors for a specific user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — ClearAssessorsRequestContent

Responses

Status	Description	Schema
`204`	Risk assessment assessors cleared.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:users.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{id}/rolesGet a user's roles

Parameters

Name	In	Required	Type
`id`	path	yes	string
`per_page`	query	no	integer
`page`	query	no	integer
`include_totals`	query	no	boolean

Responses

Status	Description	Schema
`200`	Roles successfully retrieved.	`ListUserRolesResponseContent`
`400`	Invalid request query string. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected all of: read:users, read:roles, read:role_members.	—
`404`	User not found.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/users/{id}/rolesAssign roles to a user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — AssignUserRolesRequestContent

Responses

Status	Description	Schema
`204`	Roles successfully associated with user.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:roles, update:users.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{id}/rolesRemoves roles from a user

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — DeleteUserRolesRequestContent

Responses

Status	Description	Schema
`204`	Users roles successfully removed.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:users.	—
`404`	The user does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{user_id}/refresh-tokensGet refresh tokens for a user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	The refresh tokens were retrieved	`ListRefreshTokensPaginatedResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope, expected: read:refresh_tokens	—
`404`	User not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{user_id}/refresh-tokensDelete refresh tokens for a user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string

Responses

Status	Description	Schema
`202`	Refresh token deletion request accepted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:refresh_tokens	—
`404`	User not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/users/{user_id}/sessionsGet sessions for user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string
`include_totals`	query	no	boolean
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	The sessions were retrieved	`ListUserSessionsPaginatedResponseContent`
`401`	Invalid token.	—
`403`	Insufficient scope, expected any of: read:sessions	—
`404`	User not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/users/{user_id}/sessionsDelete sessions for user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string

Responses

Status	Description	Schema
`202`	Session deletion request accepted.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected: delete:sessions	—
`404`	User not found	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

users-by-email1

GET/users-by-emailSearch Users by Email

Parameters

Name	In	Required	Type
`fields`	query	no	string
`include_fields`	query	no	boolean
`email`	query	yes	string

Responses

Status	Description	Schema
`200`	Users successfully searched.	—
`400`	Invalid request URI. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	User to be acted on does not match subject in bearer token.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

verifiable-credentials5

GET/verifiable-credentials/verification/templatesList verifiable credential templates for a tenant.

Parameters

Name	In	Required	Type
`from`	query	no	string
`take`	query	no	integer

Responses

Status	Description	Schema
`200`	Templates successfully retrieved.	`ListVerifiableCredentialTemplatesPaginatedResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:vdcs_templates.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

POST/verifiable-credentials/verification/templatesCreate a verifiable credential template.

Request body

application/json — CreateVerifiableCredentialTemplateRequestContent

Responses

Status	Description	Schema
`201`	Template successfully created.	`CreateVerifiableCredentialTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:vdcs_templates.	—
`409`	Template (name) already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

GET/verifiable-credentials/verification/templates/{id}Get a verifiable credential template by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Template successfully retrieved.	`GetVerifiableCredentialTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: read:vdcs_templates.	—
`404`	The verifiable credential template does not exist.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

PATCH/verifiable-credentials/verification/templates/{id}Update a verifiable credential template by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — UpdateVerifiableCredentialTemplateRequestContent

Responses

Status	Description	Schema
`200`	Template successfully updated.	`UpdateVerifiableCredentialTemplateResponseContent`
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: update:vdcs_templates.	—
`409`	Template (name) already exists.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

DELETE/verifiable-credentials/verification/templates/{id}Delete a verifiable credential template by ID.

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Template successfully deleted.	—
`400`	Invalid request body. The message will vary depending on the cause.	—
`401`	Invalid token.	—
`403`	Insufficient scope; expected any of: delete:vdcs_templates.	—
`429`	Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.	—

Try it

Operation

API key

Developer reference

Base URLhttps://{TENANT}.auth0.com/api/v2

Rate limit

Enforced per-tenant (not per-endpoint) via a token-bucket burst+sustained model, and varies by subscription: Free/Development tenants get a 2 requests/second sustained ceiling (burst 2) for general Management API calls, with narrower per-endpoint carve-outs (e.g. connection-status reads at 15/second, dynamic client registration at 5/second); paid Essentials/Professional/Enterprise tenants get higher published ceilings. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (Unix timestamp) headers, and exceeding the limit returns 429 -- Auth0 recommends backing off until X-RateLimit-Reset rather than retrying immediately.

Key endpoints

GET/users
GET/clients
GET/connections
GET/roles
GET/organizations

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

People comparing Auth0 also look at…

Auth0 vs MojoAuth

Auth0 vs Stytch

Auth0 vs GetOTP