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 not 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/json: schema: $ref: '#/components/schemas/CreateActionModuleVersionResponseContent' '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: update:actions.' '404': description: The action module does not exist. '409': description: No draft version is available to publish. '412': description: Maximum number of module versions reached. Consolidate versions used in actions before creating new ones. operationId: post_action_module_version x-release-lifecycle: EA x-operation-name: create x-operation-group: - actions - modules - versions security: - bearerAuth: [] - oAuth2ClientCredentials: - update:actions /actions/modules/{id}/versions/{versionId}: get: summary: Get a Specific Version of an Actions Module description: Retrieve the details of a specific, immutable version of an Actions Module. tags: - actions parameters: - name: id in: path description: The unique ID of the module. required: true schema: type: string - name: versionId in: path description: The unique ID of the module version to retrieve. required: true schema: type: string responses: '200': description: The module version was retrieved. content: application/json: schema: $ref: '#/components/schemas/GetActionModuleVersionResponseContent' '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 module or 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_module_version x-release-lifecycle: EA x-operation-name: get x-operation-group: - actions - modules - versions security: - bearerAuth: [] - oAuth2ClientCredentials: - read:actions /actions/triggers: get: summary: Get Triggers description: 'Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound. ' tags: - actions responses: '200': description: The triggers were retrieved. content: application/json: schema: $ref: '#/components/schemas/ListActionTriggersResponseContent' '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_triggers x-release-lifecycle: GA x-operation-name: list x-operation-group: - actions - triggers security: - bearerAuth: [] - oAuth2ClientCredentials: - read:actions /actions/triggers/{triggerId}/bindings: get: summary: Get Trigger Bindings description: 'Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow. ' tags: - actions parameters: - name: triggerId in: path description: An actions extensibility point. required: true schema: $ref: '#/components/schemas/ActionTriggerTypeEnum' - 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 in a single request. 20 by default schema: type: integer responses: '200': description: The bindings were retrieved. content: application/json: schema: $ref: '#/components/schemas/ListActionBindingsPaginatedResponseContent' '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_bindings x-release-lifecycle: GA x-operation-name: list x-operation-request-parameters-name: ListActionTriggerBindingsRequestParameters x-operation-group: - actions - triggers - bindings security: - bearerAuth: [] - oAuth2ClientCredentials: - read:actions patch: summary: Update Trigger Bindings description: Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed. tags: - actions parameters: - name: triggerId in: path description: An actions extensibility point. required: true schema: $ref: '#/components/schemas/ActionTriggerTypeEnum' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateActionBindingsRequestContent' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateActionBindingsRequestContent' responses: '200': description: The bindings were updated. content: application/json: schema: $ref: '#/components/schemas/UpdateActionBindingsResponseContent' '400': description: Invalid Request Body. x-description-1: 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: update:actions.' '429': description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers. operationId: patch_bindings x-release-lifecycle: GA x-operation-name: updateMany x-operation-group: - actions - triggers - bindings security: - bearerAuth: [] - oAuth2ClientCredentials: - update:actions components: schemas: ActionBindingRefTypeEnum: type: string description: 'How the action is being referred to: `action_id` or `action_name`.' default: action_name enum: - binding_id - action_id - action_name Integration: type: object description: 'Integration defines a self contained functioning unit which partners publish. A partner may create one or many of these integrations.' additionalProperties: false properties: id: type: string description: 'id is a system generated GUID. This same ID is designed to be federated in all the applicable localities.' default: 8e9fe2d0-a2fc-4c8c-9e35-dae5afadb70b catalog_id: type: string description: catalog_id refers to the ID in the marketplace catalog default: awesome-auth0-integration url_slug: type: string description: url_slug refers to the url_slug in the marketplace catalog default: awesome-auth0-integration-slug partner_id: type: string description: 'partner_id is the foreign key reference to the partner account this integration belongs to.' default: b8575c12-8d9d-4b5c-b28e-671fe9d39029 name: type: string description: 'name is the integration name, which will be used for display purposes in the marketplace. To start we''re going to make sure the display name is at least 3 characters. Can adjust this easily later.' default: Example Auth0 integration description: type: string description: 'description adds more text for the integration name -- also relevant for the marketplace listing.' default: An awesome Auth0 integration short_description: type: string description: short_description is the brief description of the integration, which is used for display purposes in cards default: Awesome Auth0 integration logo: type: string feature_type: $ref: '#/components/schemas/IntegrationFeatureTypeEnum' terms_of_use_url: type: string privacy_policy_url: type: string public_support_link: type: string current_release: $ref: '#/components/schemas/IntegrationRelease' created_at: type: string default: '2021-06-21T15:47:29.072Z' format: date-time updated_at: type: string default: '2021-06-21T15:47:29.072Z' format: date-time UpdateActionBindingsResponseContent: type: object additionalProperties: false properties: bindings: type: array items: $ref: '#/components/schemas/ActionBinding' ActionModuleSecretRequest: type: object additionalProperties: false required: - name - value properties: name: type: string description: The name of the secret. maxLength: 255 pattern: "^[^\0]*$" value: type: string description: The value of the secret. maxLength: 4096 pattern: "^[^\0]*$" ActionError: type: object description: Error is a generic error with a human readable id which should be easily referenced in support tickets. additionalProperties: false properties: id: type: string msg: type: string url: type: string ActionDeployedVersion: type: object description: The version of the action that is currently deployed. additionalProperties: false properties: id: type: string description: The unique id of an action version. default: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d action_id: type: string description: The id of the action to which this version belongs. default: 910b1053-577f-4d81-a8c8-020e7319a38a code: type: string description: The source code of this specific version of the action. default: module.exports = () => {} dependencies: type: array description: 'The list of third party npm modules, and their versions, that this specific version depends on. ' items: $ref: '#/components/schemas/ActionVersionDependency' deployed: type: boolean description: Indicates if this specific version is the currently one deployed. default: true runtime: type: string description: 'The Node runtime. For example: `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' status: $ref: '#/components/schemas/ActionVersionBuildStatusEnum' number: type: number description: The index of this version in list of versions for the action. default: 1 errors: type: array description: Any errors that occurred while the version was being built. items: $ref: '#/components/schemas/ActionError' action: $ref: '#/components/schemas/ActionBase' built_at: type: string description: The time when this version was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time created_at: type: string description: The time when this version was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. default: '2021-01-01T00:00:00.000Z' format: date-time supported_triggers: type: array description: The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA modules: type: array description: The list of action modules and their versions used by this action version. items: $ref: '#/components/schemas/ActionModuleReference' ActionExecutionStatusEnum: type: string description: The overall status of an execution. default: final enum: - unspecified - pending - final - partial - canceled - suspended ActionModuleReference: type: object description: Reference to a module and its version used by an action. additionalProperties: false properties: module_id: type: string description: The unique ID of the module. module_name: type: string description: The name of the module. module_version_id: type: string description: The ID of the specific module version. module_version_number: type: integer description: The version number of the module. ActionVersionDependency: type: object description: Dependency is an npm module. These values are used to produce an immutable artifact, which manifests as a layer_id. additionalProperties: false properties: name: type: string description: name is the name of the npm module, e.g. lodash version: type: string description: description is the version of the npm module, e.g. 4.17.1 registry_url: type: string description: registry_url is an optional value used primarily for private npm registries. DeployActionVersionRequestContent: type: - object - 'null' additionalProperties: false properties: update_draft: type: boolean description: True if the draft of the action should be updated with the reverted version. default: false ActionModuleVersion: type: object additionalProperties: false properties: id: type: string description: The unique ID for this version. module_id: type: string description: The ID of the parent module. version_number: type: integer description: The sequential version number. code: type: string description: The exact source code that was published with this version. secrets: type: array description: Secrets available to this version (name and updated_at only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' dependencies: type: array description: Dependencies locked to this version. items: $ref: '#/components/schemas/ActionModuleDependency' created_at: type: string description: The timestamp when this version was created. format: date-time ActionModuleDependencyRequest: type: object additionalProperties: false required: - name - version properties: name: type: string description: The name of the npm dependency. maxLength: 255 pattern: "^[^\0]*$" version: type: string description: The version of the npm dependency. maxLength: 50 pattern: "^[^\0]*$" CreateActionModuleResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the module. name: type: string description: The name of the module. code: type: string description: The source code from the module's draft version. dependencies: type: array description: The npm dependencies from the module's draft version. items: $ref: '#/components/schemas/ActionModuleDependency' secrets: type: array description: The secrets from the module's draft version (names and timestamps only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' actions_using_module_total: type: integer description: The number of deployed actions using this module. all_changes_published: type: boolean description: Whether all draft changes have been published as a version. latest_version_number: type: integer description: The version number of the latest published version. Omitted if no versions have been published. created_at: type: string description: Timestamp when the module was created. format: date-time updated_at: type: string description: Timestamp when the module was last updated. format: date-time latest_version: $ref: '#/components/schemas/ActionModuleVersionReference' ListActionsPaginatedResponseContent: type: object additionalProperties: false properties: total: type: number description: The total result count. default: 1 page: type: number description: Page index of the results being returned. First page is 0. default: 0 per_page: type: number description: Number of results per page. default: 20 actions: type: array description: The list of actions. items: $ref: '#/components/schemas/Action' RollbackActionModuleResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the module. name: type: string description: The name of the module. code: type: string description: The source code from the module's draft version. dependencies: type: array description: The npm dependencies from the module's draft version. items: $ref: '#/components/schemas/ActionModuleDependency' secrets: type: array description: The secrets from the module's draft version (names and timestamps only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' actions_using_module_total: type: integer description: The number of deployed actions using this module. all_changes_published: type: boolean description: Whether all draft changes have been published as a version. latest_version_number: type: integer description: The version number of the latest published version. Omitted if no versions have been published. created_at: type: string description: Timestamp when the module was created. format: date-time updated_at: type: string description: Timestamp when the module was last updated. format: date-time latest_version: $ref: '#/components/schemas/ActionModuleVersionReference' ActionModuleSecret: type: object additionalProperties: false properties: name: type: string description: The name of the secret. updated_at: type: string description: The time when the secret was last updated. format: date-time ActionVersionBuildStatusEnum: type: string description: The build status of this specific version. default: built enum: - pending - building - packaged - built - retrying - failed IntegrationRequiredParamOption: type: object additionalProperties: false properties: value: type: string description: The value of an option that will be used within the application. label: type: string description: The display value of an option suitable for displaying in a UI. UpdateActionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the action. default: 910b1053-577f-4d81-a8c8-020e7319a38a name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA all_changes_deployed: type: boolean description: True if all of an Action's contents have been deployed. default: false created_at: type: string description: The time when this action was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when this action was updated. default: '2021-01-01T00:00:00.000Z' format: date-time code: type: string description: The source code of the action. default: module.exports = () => {} dependencies: type: array description: The list of third party npm modules, and their versions, that this action depends on. items: $ref: '#/components/schemas/ActionVersionDependency' runtime: type: string description: 'The Node runtime. For example: `node22`, defaults to `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' deployed_version: $ref: '#/components/schemas/ActionDeployedVersion' installed_integration_id: type: string description: installed_integration_id is the fk reference to the InstalledIntegration entity. default: 7d2bc0c9-c0c2-433a-9f4e-86ef80270aad integration: $ref: '#/components/schemas/Integration' status: $ref: '#/components/schemas/ActionBuildStatusEnum' built_at: type: string description: The time when this action was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time deploy: type: boolean description: True if the action should be deployed after creation. default: false modules: type: array description: The list of action modules and their versions used by this action. items: $ref: '#/components/schemas/ActionModuleReference' UpdateActionModuleRequestContent: type: object additionalProperties: false properties: code: type: string description: The source code of the action module. maxLength: 65536 pattern: "^[^\0]*$" secrets: type: array description: The secrets to associate with the action module. items: $ref: '#/components/schemas/ActionModuleSecretRequest' dependencies: type: array description: The npm dependencies of the action module. items: $ref: '#/components/schemas/ActionModuleDependencyRequest' GetActionModuleActionsResponseContent: type: object additionalProperties: false properties: actions: type: array description: A list of action references. items: $ref: '#/components/schemas/ActionModuleAction' total: type: integer description: The total number of actions using this module. page: type: integer description: The page index of the returned results. per_page: type: integer description: The number of results requested per page. ActionTrigger: type: object additionalProperties: false required: - id x-release-lifecycle: GA properties: id: $ref: '#/components/schemas/ActionTriggerTypeEnum' version: type: string description: The version of a trigger. v1, v2, etc. status: type: string description: status points to the trigger status. runtimes: type: array description: runtimes supported by this trigger. items: type: string default_runtime: type: string description: Runtime that will be used when none is specified when creating an action. compatible_triggers: type: array description: compatible_triggers informs which other trigger supports the same event and api. items: $ref: '#/components/schemas/ActionTriggerCompatibleTrigger' binding_policy: $ref: '#/components/schemas/ActionBindingTypeEnum' ActionTriggerTypeEnum: type: string description: An actions extensibility point. enum: - post-login - credentials-exchange - pre-user-registration - post-user-registration - post-change-password - send-phone-message - custom-phone-provider - custom-email-provider - password-reset-post-challenge - custom-token-exchange - event-stream - password-hash-migration - login-post-identifier - signup-post-identifier ActionModuleVersionReference: type: object description: The latest published version as a reference object. Omitted if no versions have been published. additionalProperties: false properties: id: type: string description: The unique ID of the version. version_number: type: integer description: The version number. code: type: string description: The source code from this version. dependencies: type: array description: The npm dependencies from this version. items: $ref: '#/components/schemas/ActionModuleDependency' secrets: type: array description: The secrets from this version (names and timestamps only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' created_at: type: string description: Timestamp when the version was created. format: date-time ActionBindingTypeEnum: type: string description: In order to execute an Action, it must be bound to a trigger using a binding. `trigger-bound` means that bindings are managed by the tenant. `entity-bound` means that the bindings are automatically managed by Auth0 and other internal resouces will control those bindings. Tenants cannot manage `entity-bound` bindings. enum: - trigger-bound - entity-bound GetActionModuleVersionsResponseContent: type: object additionalProperties: false properties: versions: type: array description: A list of ActionsModuleVersion objects. items: $ref: '#/components/schemas/ActionModuleVersion' total: type: integer description: The total number of versions for this module. page: type: integer description: The page index of the returned results. per_page: type: integer description: The number of results requested per page. TestActionResponseContent: type: object additionalProperties: false properties: payload: $ref: '#/components/schemas/TestActionResultPayload' IntegrationRelease: type: object additionalProperties: true properties: id: type: string description: The id of the associated IntegrationRelease trigger: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA semver: $ref: '#/components/schemas/IntegrationSemVer' required_secrets: type: array description: 'required_secrets declares all the necessary secrets for an integration to work.' items: $ref: '#/components/schemas/IntegrationRequiredParam' required_configuration: type: array description: required_configuration declares all the necessary configuration fields for an integration to work. items: $ref: '#/components/schemas/IntegrationRequiredParam' ActionModuleDependency: type: object additionalProperties: false properties: name: type: string description: The name of the npm dependency. version: type: string description: The version of the npm dependency. UpdateActionBindingsRequestContent: type: object additionalProperties: false properties: bindings: type: array description: The actions that will be bound to this trigger. The order in which they are included will be the order in which they are executed. items: $ref: '#/components/schemas/UpdateActionBindingItem' ActionBinding: type: object description: Binding is the associative entity joining a trigger, and an action together. additionalProperties: false properties: id: type: string description: The unique ID of this binding. default: 4a881e22-0562-4178-bc91-b0f2b321dc13 trigger_id: $ref: '#/components/schemas/ActionTriggerTypeEnum' display_name: type: string description: The name of the binding. default: my-action-1 action: $ref: '#/components/schemas/Action' created_at: type: string description: The time when the binding was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when the binding was updated. default: '2021-01-01T00:00:00.000Z' format: date-time CreateActionModuleRequestContent: type: object additionalProperties: false required: - name - code properties: name: type: string description: The name of the action module. maxLength: 255 pattern: "^[^\0]*$" code: type: string description: The source code of the action module. maxLength: 65536 pattern: "^[^\0]*$" secrets: type: array description: The secrets to associate with the action module. items: $ref: '#/components/schemas/ActionModuleSecretRequest' dependencies: type: array description: The npm dependencies of the action module. items: $ref: '#/components/schemas/ActionModuleDependencyRequest' api_version: type: string description: The API version of the module. maxLength: 20 pattern: "^[^\0]*$" publish: type: boolean description: Whether to publish the module immediately after creation. GetActionModuleResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the module. name: type: string description: The name of the module. code: type: string description: The source code from the module's draft version. dependencies: type: array description: The npm dependencies from the module's draft version. items: $ref: '#/components/schemas/ActionModuleDependency' secrets: type: array description: The secrets from the module's draft version (names and timestamps only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' actions_using_module_total: type: integer description: The number of deployed actions using this module. all_changes_published: type: boolean description: Whether all draft changes have been published as a version. latest_version_number: type: integer description: The version number of the latest published version. Omitted if no versions have been published. created_at: type: string description: Timestamp when the module was created. format: date-time updated_at: type: string description: Timestamp when the module was last updated. format: date-time latest_version: $ref: '#/components/schemas/ActionModuleVersionReference' GetActionVersionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique id of an action version. default: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d action_id: type: string description: The id of the action to which this version belongs. default: 910b1053-577f-4d81-a8c8-020e7319a38a code: type: string description: The source code of this specific version of the action. default: module.exports = () => {} dependencies: type: array description: 'The list of third party npm modules, and their versions, that this specific version depends on. ' items: $ref: '#/components/schemas/ActionVersionDependency' deployed: type: boolean description: Indicates if this specific version is the currently one deployed. default: true runtime: type: string description: 'The Node runtime. For example: `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' status: $ref: '#/components/schemas/ActionVersionBuildStatusEnum' number: type: number description: The index of this version in list of versions for the action. default: 1 errors: type: array description: Any errors that occurred while the version was being built. items: $ref: '#/components/schemas/ActionError' action: $ref: '#/components/schemas/ActionBase' built_at: type: string description: The time when this version was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time created_at: type: string description: The time when this version was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. default: '2021-01-01T00:00:00.000Z' format: date-time supported_triggers: type: array description: The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA modules: type: array description: The list of action modules and their versions used by this action version. items: $ref: '#/components/schemas/ActionModuleReference' ActionModuleListItem: type: object additionalProperties: false properties: id: type: string description: The unique ID of the module. name: type: string description: The name of the module. code: type: string description: The source code from the module's draft version. dependencies: type: array description: The npm dependencies from the module's draft version. items: $ref: '#/components/schemas/ActionModuleDependency' secrets: type: array description: The secrets from the module's draft version (names and timestamps only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' actions_using_module_total: type: integer description: The number of deployed actions using this module. all_changes_published: type: boolean description: Whether all draft changes have been published as a version. latest_version_number: type: integer description: The version number of the latest published version. Omitted if no versions have been published. created_at: type: string description: Timestamp when the module was created. format: date-time updated_at: type: string description: Timestamp when the module was last updated. format: date-time CreateActionRequestContent: type: object additionalProperties: false required: - name - supported_triggers properties: name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA code: type: string description: The source code of the action. default: module.exports = () => {} dependencies: type: array description: The list of third party npm modules, and their versions, that this action depends on. items: $ref: '#/components/schemas/ActionVersionDependency' runtime: type: string description: 'The Node runtime. For example: `node22`, defaults to `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretRequest' modules: type: array description: The list of action modules and their versions used by this action. items: $ref: '#/components/schemas/ActionModuleReference' deploy: type: boolean description: True if the action should be deployed after creation. default: false IntegrationSemVer: type: object description: Semver denotes the major.minor version of an integration release additionalProperties: false properties: major: type: integer description: Major is the major number of a semver default: 1 minor: type: integer description: Minior is the minior number of a semver default: 1 GetActionModulesResponseContent: type: object additionalProperties: false properties: modules: type: array description: A list of ActionsModule objects. items: $ref: '#/components/schemas/ActionModuleListItem' total: type: integer description: The total number of modules in the tenant. page: type: integer description: The page index of the returned results. per_page: type: integer description: The number of results requested per page. UpdateActionBindingItem: oneOf: - $ref: '#/components/schemas/ActionBindingWithRef' TestActionPayload: type: object description: The payload for the action. additionalProperties: true GetActionModuleVersionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID for this version. module_id: type: string description: The ID of the parent module. version_number: type: integer description: The sequential version number. code: type: string description: The exact source code that was published with this version. secrets: type: array description: Secrets available to this version (name and updated_at only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' dependencies: type: array description: Dependencies locked to this version. items: $ref: '#/components/schemas/ActionModuleDependency' created_at: type: string description: The timestamp when this version was created. format: date-time RollbackActionModuleRequestContent: type: object additionalProperties: false required: - module_version_id properties: module_version_id: type: string description: The unique ID of the module version to roll back to. ActionBindingRef: type: object description: A reference to an action. An action can be referred to by ID or by Name. additionalProperties: true properties: type: $ref: '#/components/schemas/ActionBindingRefTypeEnum' value: type: string description: The id or name of an action that is being bound to a trigger. default: my-action IntegrationFeatureTypeEnum: type: string description: feature_type is the type of the integration. default: action enum: - unspecified - action - social_connection - log_stream - sso_integration - sms_provider ActionBuildStatusEnum: type: string description: The build status of this action. default: built enum: - pending - building - packaged - built - retrying - failed DeployActionVersionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique id of an action version. default: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d action_id: type: string description: The id of the action to which this version belongs. default: 910b1053-577f-4d81-a8c8-020e7319a38a code: type: string description: The source code of this specific version of the action. default: module.exports = () => {} dependencies: type: array description: 'The list of third party npm modules, and their versions, that this specific version depends on. ' items: $ref: '#/components/schemas/ActionVersionDependency' deployed: type: boolean description: Indicates if this specific version is the currently one deployed. default: true runtime: type: string description: 'The Node runtime. For example: `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' status: $ref: '#/components/schemas/ActionVersionBuildStatusEnum' number: type: number description: The index of this version in list of versions for the action. default: 1 errors: type: array description: Any errors that occurred while the version was being built. items: $ref: '#/components/schemas/ActionError' action: $ref: '#/components/schemas/ActionBase' built_at: type: string description: The time when this version was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time created_at: type: string description: The time when this version was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. default: '2021-01-01T00:00:00.000Z' format: date-time supported_triggers: type: array description: The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA modules: type: array description: The list of action modules and their versions used by this action version. items: $ref: '#/components/schemas/ActionModuleReference' ActionSecretRequest: type: object additionalProperties: true properties: name: type: string description: The name of the particular secret, e.g. API_KEY. default: mySecret value: type: string description: The value of the particular secret, e.g. secret123. A secret's value can only be set upon creation. A secret's value will never be returned by the API. default: mySecretValue ActionTriggerCompatibleTrigger: type: object additionalProperties: true required: - id - version properties: id: $ref: '#/components/schemas/ActionTriggerTypeEnum' version: type: string description: The version of a trigger. v1, v2, etc. UpdateActionModuleResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the module. name: type: string description: The name of the module. code: type: string description: The source code from the module's draft version. dependencies: type: array description: The npm dependencies from the module's draft version. items: $ref: '#/components/schemas/ActionModuleDependency' secrets: type: array description: The secrets from the module's draft version (names and timestamps only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' actions_using_module_total: type: integer description: The number of deployed actions using this module. all_changes_published: type: boolean description: Whether all draft changes have been published as a version. latest_version_number: type: integer description: The version number of the latest published version. Omitted if no versions have been published. created_at: type: string description: Timestamp when the module was created. format: date-time updated_at: type: string description: Timestamp when the module was last updated. format: date-time latest_version: $ref: '#/components/schemas/ActionModuleVersionReference' GetActionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the action. default: 910b1053-577f-4d81-a8c8-020e7319a38a name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA all_changes_deployed: type: boolean description: True if all of an Action's contents have been deployed. default: false created_at: type: string description: The time when this action was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when this action was updated. default: '2021-01-01T00:00:00.000Z' format: date-time code: type: string description: The source code of the action. default: module.exports = () => {} dependencies: type: array description: The list of third party npm modules, and their versions, that this action depends on. items: $ref: '#/components/schemas/ActionVersionDependency' runtime: type: string description: 'The Node runtime. For example: `node22`, defaults to `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' deployed_version: $ref: '#/components/schemas/ActionDeployedVersion' installed_integration_id: type: string description: installed_integration_id is the fk reference to the InstalledIntegration entity. default: 7d2bc0c9-c0c2-433a-9f4e-86ef80270aad integration: $ref: '#/components/schemas/Integration' status: $ref: '#/components/schemas/ActionBuildStatusEnum' built_at: type: string description: The time when this action was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time deploy: type: boolean description: True if the action should be deployed after creation. default: false modules: type: array description: The list of action modules and their versions used by this action. items: $ref: '#/components/schemas/ActionModuleReference' TestActionRequestContent: type: object additionalProperties: false required: - payload properties: payload: $ref: '#/components/schemas/TestActionPayload' ActionVersion: type: object additionalProperties: false properties: id: type: string description: The unique id of an action version. default: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d action_id: type: string description: The id of the action to which this version belongs. default: 910b1053-577f-4d81-a8c8-020e7319a38a code: type: string description: The source code of this specific version of the action. default: module.exports = () => {} dependencies: type: array description: 'The list of third party npm modules, and their versions, that this specific version depends on. ' items: $ref: '#/components/schemas/ActionVersionDependency' deployed: type: boolean description: Indicates if this specific version is the currently one deployed. default: true runtime: type: string description: 'The Node runtime. For example: `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' status: $ref: '#/components/schemas/ActionVersionBuildStatusEnum' number: type: number description: The index of this version in list of versions for the action. default: 1 errors: type: array description: Any errors that occurred while the version was being built. items: $ref: '#/components/schemas/ActionError' action: $ref: '#/components/schemas/ActionBase' built_at: type: string description: The time when this version was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time created_at: type: string description: The time when this version was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. default: '2021-01-01T00:00:00.000Z' format: date-time supported_triggers: type: array description: The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA modules: type: array description: The list of action modules and their versions used by this action version. items: $ref: '#/components/schemas/ActionModuleReference' ActionExecutionResult: type: object description: Captures the results of a single action being executed. additionalProperties: false properties: action_name: type: string description: The name of the action that was executed. default: my-action error: $ref: '#/components/schemas/ActionError' started_at: type: string description: The time when the action was started. default: '2021-01-01T00:00:00.000Z' format: date-time ended_at: type: string description: The time when the action finished executing. default: '2021-01-01T00:00:00.000Z' format: date-time Action: type: object additionalProperties: false properties: id: type: string description: The unique ID of the action. default: 910b1053-577f-4d81-a8c8-020e7319a38a name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA all_changes_deployed: type: boolean description: True if all of an Action's contents have been deployed. default: false created_at: type: string description: The time when this action was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when this action was updated. default: '2021-01-01T00:00:00.000Z' format: date-time code: type: string description: The source code of the action. default: module.exports = () => {} dependencies: type: array description: The list of third party npm modules, and their versions, that this action depends on. items: $ref: '#/components/schemas/ActionVersionDependency' runtime: type: string description: 'The Node runtime. For example: `node22`, defaults to `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' deployed_version: $ref: '#/components/schemas/ActionDeployedVersion' installed_integration_id: type: string description: installed_integration_id is the fk reference to the InstalledIntegration entity. default: 7d2bc0c9-c0c2-433a-9f4e-86ef80270aad integration: $ref: '#/components/schemas/Integration' status: $ref: '#/components/schemas/ActionBuildStatusEnum' built_at: type: string description: The time when this action was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time deploy: type: boolean description: True if the action should be deployed after creation. default: false modules: type: array description: The list of action modules and their versions used by this action. items: $ref: '#/components/schemas/ActionModuleReference' IntegrationRequiredParam: type: object description: 'Param are form input values, primarily utilized when specifying secrets and configuration values for actions. These are especially important for partner integrations -- but can be exposed to tenant admins as well if they want to parameterize their custom actions.' additionalProperties: false properties: type: $ref: '#/components/schemas/IntegrationRequiredParamTypeEnum' name: type: string description: The name of the parameter. required: type: boolean description: The flag for if this parameter is required. optional: type: boolean description: The temp flag for if this parameter is required (experimental; for Labs use only). label: type: string description: The short label for this parameter. description: type: string description: The lengthier description for this parameter. default_value: type: string description: The default value for this parameter. placeholder: type: string description: Placeholder text for this parameter. options: type: array description: The allowable options for this param. items: $ref: '#/components/schemas/IntegrationRequiredParamOption' DeployActionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique id of an action version. default: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d action_id: type: string description: The id of the action to which this version belongs. default: 910b1053-577f-4d81-a8c8-020e7319a38a code: type: string description: The source code of this specific version of the action. default: module.exports = () => {} dependencies: type: array description: 'The list of third party npm modules, and their versions, that this specific version depends on. ' items: $ref: '#/components/schemas/ActionVersionDependency' deployed: type: boolean description: Indicates if this specific version is the currently one deployed. default: true runtime: type: string description: 'The Node runtime. For example: `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' status: $ref: '#/components/schemas/ActionVersionBuildStatusEnum' number: type: number description: The index of this version in list of versions for the action. default: 1 errors: type: array description: Any errors that occurred while the version was being built. items: $ref: '#/components/schemas/ActionError' action: $ref: '#/components/schemas/ActionBase' built_at: type: string description: The time when this version was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time created_at: type: string description: The time when this version was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built. default: '2021-01-01T00:00:00.000Z' format: date-time supported_triggers: type: array description: The list of triggers that this version supports. At this time, a version can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA modules: type: array description: The list of action modules and their versions used by this action version. items: $ref: '#/components/schemas/ActionModuleReference' ListActionTriggersResponseContent: type: object additionalProperties: false properties: triggers: type: array items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA IntegrationRequiredParamTypeEnum: type: string enum: - UNSPECIFIED - STRING ActionSecretResponse: type: object additionalProperties: true properties: name: type: string description: The name of the particular secret, e.g. API_KEY. default: mySecret updated_at: type: string description: The time when the secret was last updated. default: '2021-01-01T00:00:00.000Z' format: date-time ListActionBindingsPaginatedResponseContent: type: object additionalProperties: false properties: total: type: number description: The total result count. default: 1 page: type: number description: Page index of the results being returned. First page is 0. default: 0 per_page: type: number description: Number of results per page. default: 20 bindings: type: array description: The list of actions that are bound to this trigger in the order in which they will be executed. items: $ref: '#/components/schemas/ActionBinding' GetActionExecutionResponseContent: type: object description: The result of a specific execution of a trigger. additionalProperties: false properties: id: type: string description: ID identifies this specific execution simulation. These IDs would resemble real executions in production. default: c5b35bb1-c67d-40bb-9b0d-700b6fe33dd9 trigger_id: $ref: '#/components/schemas/ActionTriggerTypeEnum' status: $ref: '#/components/schemas/ActionExecutionStatusEnum' results: type: array items: $ref: '#/components/schemas/ActionExecutionResult' created_at: type: string description: The time that the execution was started. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time that the exeution finished executing. default: '2021-01-01T00:00:00.000Z' format: date-time ActionBindingWithRef: type: object additionalProperties: false required: - ref properties: ref: $ref: '#/components/schemas/ActionBindingRef' display_name: type: string description: The name of the binding. default: my-action-1 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretRequest' ActionModuleAction: type: object additionalProperties: false properties: action_id: type: string description: The unique ID of the action. action_name: type: string description: The name of the action. module_version_id: type: string description: The ID of the module version this action is using. module_version_number: type: integer description: The version number of the module this action is using. supported_triggers: type: array description: The triggers that this action supports. items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA ActionBase: type: object description: The action to which this version belongs. additionalProperties: false properties: id: type: string description: The unique ID of the action. default: 910b1053-577f-4d81-a8c8-020e7319a38a name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA all_changes_deployed: type: boolean description: True if all of an Action's contents have been deployed. default: false created_at: type: string description: The time when this action was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when this action was updated. default: '2021-01-01T00:00:00.000Z' format: date-time ListActionVersionsPaginatedResponseContent: type: object additionalProperties: false properties: total: type: number description: The total result count. default: 1 page: type: number description: Page index of the results being returned. First page is 0. default: 0 per_page: type: number description: Number of results per page. default: 20 versions: type: array items: $ref: '#/components/schemas/ActionVersion' CreateActionModuleVersionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID for this version. module_id: type: string description: The ID of the parent module. version_number: type: integer description: The sequential version number. code: type: string description: The exact source code that was published with this version. secrets: type: array description: Secrets available to this version (name and updated_at only, values never returned). items: $ref: '#/components/schemas/ActionModuleSecret' dependencies: type: array description: Dependencies locked to this version. items: $ref: '#/components/schemas/ActionModuleDependency' created_at: type: string description: The timestamp when this version was created. format: date-time UpdateActionRequestContent: type: object additionalProperties: false properties: name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA code: type: string description: The source code of the action. default: module.exports = () => {} dependencies: type: array description: The list of third party npm modules, and their versions, that this action depends on. items: $ref: '#/components/schemas/ActionVersionDependency' runtime: type: string description: 'The Node runtime. For example: `node22`, defaults to `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretRequest' modules: type: array description: The list of action modules and their versions used by this action. items: $ref: '#/components/schemas/ActionModuleReference' TestActionResultPayload: type: object description: The resulting payload after an action was executed. additionalProperties: true CreateActionResponseContent: type: object additionalProperties: false properties: id: type: string description: The unique ID of the action. default: 910b1053-577f-4d81-a8c8-020e7319a38a name: type: string description: The name of an action. default: my-action supported_triggers: type: array description: The list of triggers that this action supports. At this time, an action can only target a single trigger at a time. minItems: 1 items: $ref: '#/components/schemas/ActionTrigger' x-release-lifecycle: GA all_changes_deployed: type: boolean description: True if all of an Action's contents have been deployed. default: false created_at: type: string description: The time when this action was created. default: '2021-01-01T00:00:00.000Z' format: date-time updated_at: type: string description: The time when this action was updated. default: '2021-01-01T00:00:00.000Z' format: date-time code: type: string description: The source code of the action. default: module.exports = () => {} dependencies: type: array description: The list of third party npm modules, and their versions, that this action depends on. items: $ref: '#/components/schemas/ActionVersionDependency' runtime: type: string description: 'The Node runtime. For example: `node22`, defaults to `node22`' default: node22 secrets: type: array description: The list of secrets that are included in an action or a version of an action. items: $ref: '#/components/schemas/ActionSecretResponse' deployed_version: $ref: '#/components/schemas/ActionDeployedVersion' installed_integration_id: type: string description: installed_integration_id is the fk reference to the InstalledIntegration entity. default: 7d2bc0c9-c0c2-433a-9f4e-86ef80270aad integration: $ref: '#/components/schemas/Integration' status: $ref: '#/components/schemas/ActionBuildStatusEnum' built_at: type: string description: The time when this action was built successfully. default: '2021-01-01T00:00:00.000Z' format: date-time deploy: type: boolean description: True if the action should be deployed after creation. default: false modules: type: array description: The list of action modules and their versions used by this action. items: $ref: '#/components/schemas/ActionModuleReference'