openapi: 3.0.0
info:
title: Auth0 Authentication actions API
description: Auth0 Authentication API. Endpoints for authentication and authorization using OpenID Connect, OAuth 2.0, SAML, WS-Federation, and Passwordless flows.
version: 1.0.0
servers:
- url: '{auth0_domain}'
description: The Authentication API is served over HTTPS.
variables:
auth0_domain:
description: Auth0 domain
default: https://demo.us.auth0.com
tags:
- name: actions
paths:
/actions/actions:
get:
summary: Get Actions
description: 'Retrieve all actions.
'
tags:
- actions
parameters:
- name: triggerId
in: query
description: An actions extensibility point.
schema:
$ref: '#/components/schemas/ActionTriggerTypeEnum'
- name: actionName
in: query
description: The name of the action to retrieve.
schema:
type: string
- name: deployed
in: query
description: Optional filter to only retrieve actions that are deployed.
schema:
type: boolean
- name: page
in: query
description: Use this field to request a specific page of the list results.
schema:
type: integer
- name: per_page
in: query
description: The maximum number of results to be returned by the server in single response. 20 by default
schema:
type: integer
- name: installed
in: query
description: Optional. When true, return only installed actions. When false, return only custom actions. Returns all actions by default.
schema:
type: boolean
responses:
'200':
description: The actions were retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ListActionsPaginatedResponseContent'
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_actions
x-release-lifecycle: GA
x-operation-name: list
x-operation-request-parameters-name: ListActionsRequestParameters
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
post:
summary: Create an Action
description: 'Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.
'
tags:
- actions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateActionRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateActionRequestContent'
responses:
'201':
description: Action successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateActionResponseContent'
'400':
description: Invalid Request Body.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: create:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_action
x-release-lifecycle: GA
x-operation-name: create
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- create:actions
/actions/actions/{actionId}/versions:
get:
summary: Get an Action's Versions
description: 'Retrieve all of an action''s versions. An action version is created whenever an action is deployed. An action version is immutable, once created.
'
tags:
- actions
parameters:
- name: actionId
in: path
description: The ID of the action.
required: true
schema:
type: string
- name: page
in: query
description: Use this field to request a specific page of the list results.
schema:
type: integer
- name: per_page
in: query
description: This field specify the maximum number of results to be returned by the server. 20 by default
schema:
type: integer
responses:
'200':
description: The action versions were retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ListActionVersionsPaginatedResponseContent'
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action_versions
x-release-lifecycle: GA
x-operation-name: list
x-operation-request-parameters-name: ListActionVersionsRequestParameters
x-operation-group:
- actions
- versions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
/actions/actions/{actionId}/versions/{id}:
get:
summary: Get a Specific Version of an Action
description: 'Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.
'
tags:
- actions
parameters:
- name: actionId
in: path
description: The ID of the action.
required: true
schema:
type: string
- name: id
in: path
description: The ID of the action version.
required: true
schema:
type: string
responses:
'200':
description: The action version was retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionVersionResponseContent'
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'404':
description: The action version does not exist.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action_version
x-release-lifecycle: GA
x-operation-name: get
x-operation-group:
- actions
- versions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
/actions/actions/{actionId}/versions/{id}/deploy:
post:
summary: Roll Back to a Previous Action Version
description: 'Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.
'
tags:
- actions
parameters:
- name: id
in: path
description: The ID of an action version.
required: true
schema:
type: string
- name: actionId
in: path
description: The ID of an action.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeployActionVersionRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DeployActionVersionRequestContent'
responses:
'202':
description: Request to create action version was accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/DeployActionVersionResponseContent'
'400':
description: Invalid Request Body.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: create:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_deploy_draft_version
x-release-lifecycle: GA
x-operation-name: deploy
x-operation-group:
- actions
- versions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- create:actions
/actions/actions/{id}:
get:
summary: Get an Action
description: 'Retrieve an action by its ID.
'
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the action to retrieve.
required: true
schema:
type: string
responses:
'200':
description: The action was retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionResponseContent'
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'404':
description: The action does not exist.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action
x-release-lifecycle: GA
x-operation-name: get
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
delete:
summary: Delete an Action
description: 'Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.
'
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the action to delete.
required: true
schema:
type: string
- name: force
in: query
description: Force action deletion detaching bindings
schema:
type: boolean
responses:
'204':
description: Action successfully deleted.
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: delete:actions.'
'404':
description: The action version does not exist.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: delete_action
x-release-lifecycle: GA
x-operation-name: delete
x-operation-request-parameters-name: DeleteActionRequestParameters
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- delete:actions
patch:
summary: Update an Action
description: 'Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect any user flows until the action is deployed.
'
tags:
- actions
parameters:
- name: id
in: path
description: The id of the action to update.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActionRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateActionRequestContent'
responses:
'200':
description: Action successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActionResponseContent'
'400':
description: Invalid Request Body.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: update:actions.'
'404':
description: Action not found and cannot be updated.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: patch_action
x-release-lifecycle: GA
x-operation-name: update
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- update:actions
/actions/actions/{id}/deploy:
post:
summary: Deploy an Action
description: 'Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
'
tags:
- actions
parameters:
- name: id
in: path
description: The ID of an action.
required: true
schema:
type: string
responses:
'202':
description: Request to create action version was accepted.
content:
application/json:
schema:
$ref: '#/components/schemas/DeployActionResponseContent'
'400':
description: Invalid Request Body.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: create:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_deploy_action
x-release-lifecycle: GA
x-operation-name: deploy
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- create:actions
/actions/actions/{id}/test:
post:
summary: Test an Action
description: 'Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.
'
tags:
- actions
parameters:
- name: id
in: path
description: The id of the action to test.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestActionRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TestActionRequestContent'
responses:
'200':
description: Test action version successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/TestActionResponseContent'
'400':
description: Invalid Request Body.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: create:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_test_action
x-release-lifecycle: GA
x-operation-name: test
x-operation-group: actions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- create:actions
/actions/executions/{id}:
get:
summary: Get an Execution
description: 'Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
'
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the execution to retrieve.
required: true
schema:
type: string
responses:
'200':
description: The execution was retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionExecutionResponseContent'
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'404':
description: The execution does not exist.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_execution
x-release-lifecycle: GA
x-operation-name: get
x-operation-group:
- actions
- executions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
/actions/modules:
get:
summary: List Actions Modules
description: Retrieve a paginated list of all Actions Modules with optional filtering and totals.
tags:
- actions
parameters:
- name: page
in: query
description: Page index of the results to return. First page is 0.
schema:
type: integer
- name: per_page
in: query
description: Number of results per page. Paging is disabled if parameter not sent.
schema:
type: integer
responses:
'200':
description: The action modules were retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionModulesResponseContent'
'400':
description: Invalid request query string. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action_modules
x-release-lifecycle: EA
x-operation-name: list
x-operation-request-parameters-name: GetActionModulesRequestParameters
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
post:
summary: Create a New Actions Module
description: Create a new Actions Module for reusable code across actions.
tags:
- actions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateActionModuleRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateActionModuleRequestContent'
responses:
'201':
description: The action module was created.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateActionModuleResponseContent'
'400':
description: Invalid request body. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: create:actions.'
'409':
description: An action module with the same name already exists.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_action_module
x-release-lifecycle: EA
x-operation-name: create
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- create:actions
/actions/modules/{id}:
get:
summary: Get a Specific Actions Module by ID
description: Retrieve details of a specific Actions Module by its unique identifier.
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the action module to retrieve.
required: true
schema:
type: string
responses:
'200':
description: The action module was retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionModuleResponseContent'
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'404':
description: The action module does not exist.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action_module
x-release-lifecycle: EA
x-operation-name: get
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
delete:
summary: Delete a Specific Actions Module by ID
description: Permanently delete an Actions Module. This will fail if the module is still in use by any actions.
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the Actions Module to delete.
required: true
schema:
type: string
responses:
'204':
description: The Actions Module was deleted.
'400':
description: Invalid request URI. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: delete:actions.'
'404':
description: The Actions Module does not exist.
'412':
description: The Actions Module cannot be deleted because it is in use by one or more actions.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: delete_action_module
x-release-lifecycle: EA
x-operation-name: delete
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- delete:actions
patch:
summary: Update a Specific Actions Module
description: Update properties of an existing Actions Module, such as code, dependencies, or secrets.
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the action module to update.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActionModuleRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateActionModuleRequestContent'
responses:
'200':
description: The action module was updated.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateActionModuleResponseContent'
'400':
description: Invalid request body. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: update:actions.'
'404':
description: The action module does not exist.
'409':
description: An action module with the same name already exists.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: patch_action_module
x-release-lifecycle: EA
x-operation-name: update
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- update:actions
/actions/modules/{id}/actions:
get:
summary: List All Actions Using an Actions Module
description: Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.
tags:
- actions
parameters:
- name: id
in: path
description: The unique ID of the module.
required: true
schema:
type: string
- name: page
in: query
description: Page index of the results to return. First page is 0.
schema:
type: integer
- name: per_page
in: query
description: Number of results per page.
schema:
type: integer
responses:
'200':
description: The actions were retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionModuleActionsResponseContent'
'400':
description: Invalid request query string. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'404':
description: No module exists with the specified ID.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action_module_actions
x-release-lifecycle: EA
x-operation-name: listActions
x-operation-request-parameters-name: GetActionModuleActionsRequestParameters
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
/actions/modules/{id}/rollback:
post:
summary: Rollback an Actions Module to a Previous Version
description: Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.
tags:
- actions
parameters:
- name: id
in: path
description: The unique ID of the module to roll back.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RollbackActionModuleRequestContent'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/RollbackActionModuleRequestContent'
responses:
'200':
description: The rollback was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/RollbackActionModuleResponseContent'
'400':
description: Invalid request URI or body. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: update:actions.'
'404':
description: The module or version does not exist.
'409':
description: The specified version is already the current draft version.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: post_action_module_rollback
x-release-lifecycle: EA
x-operation-name: rollback
x-operation-request-parameters-name: RollbackActionModuleRequestParameters
x-operation-group:
- actions
- modules
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- update:actions
/actions/modules/{id}/versions:
get:
summary: List All Versions of an Actions Module
description: List all published versions of a specific Actions Module.
tags:
- actions
parameters:
- name: id
in: path
description: The unique ID of the module.
required: true
schema:
type: string
- name: page
in: query
description: Use this field to request a specific page of the list results.
schema:
type: integer
- name: per_page
in: query
description: The maximum number of results to be returned by the server in a single response. 20 by default.
schema:
type: integer
responses:
'200':
description: The module versions were retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/GetActionModuleVersionsResponseContent'
'400':
description: Invalid request query string. The message will vary depending on the cause.
'401':
description: Invalid token.
x-description-1: Invalid signature received for JSON Web Token validation.
'403':
description: 'Insufficient scope, expected: read:actions.'
'404':
description: No module exists with the specified ID.
'429':
description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
operationId: get_action_module_versions
x-release-lifecycle: EA
x-operation-name: list
x-operation-request-parameters-name: GetActionModuleVersionsRequestParameters
x-operation-group:
- actions
- modules
- versions
security:
- bearerAuth: []
- oAuth2ClientCredentials:
- read:actions
post:
summary: Create a New Version of an Actions Module
description: Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development.
tags:
- actions
parameters:
- name: id
in: path
description: The ID of the action module to create a version for.
required: true
schema:
type: string
responses:
'200':
description: The action module version was created.
content:
application
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/openapi/auth0-actions-api-openapi.yml