Auth0 API | Actions › Deploy An Action

Actions

actions

Methods

Create An Action -> { id, all_changes_deployed, built_at, 13 more... }

post/actions/actions

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.

Delete An Action ->

delete/actions/actions/{id}

Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.

Deploy An Action -> { id, action, action_id, 12 more... }

post/actions/actions/{id}/deploy

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.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

id: string

Response fields

id: string

Optional

The unique id of an action version.

action: { id, all_changes_deployed, created_at, 3 more... }

Optional

The action to which this version belongs.

action_id: string

Optional

The id of the action to which this version belongs.

built_at: string

Optional

(format: date-time)

The time when this version was built successfully.

code: string

Optional

The source code of this specific version of the action.

created_at: string

Optional

(format: date-time)

The time when this version was created.

dependencies: Array<{ name, registry_url, version }>

Optional

The list of third party npm modules, and their versions, that this specific version depends on.

deployed: boolean

Optional

Indicates if this speciic version is the currently one deployed.

errors: Array<{ id, msg, url }>

Optional

Any errors that occurred while the version was being built.

number: number

Optional

The index of this version in list of versions for the action.

runtime: string

Optional

The Node runtime. For example: node12

secrets: Array<{ name, updated_at }>

Optional

The list of secrets that are included in an action or a version of an action.

status: "pending" | "building" | "packaged" | 3 more...

Optional

The build status of this specific version.

supported_triggers: Array<{ id, binding_policy, compatible_triggers, 4 more... }>

Optional

The list of triggers that this version supports. At this time, a version can only target a single trigger at a time.

updated_at: string

Optional

(format: date-time)

The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built.

Request example

curl https://login0.local.dev.auth0.com/api/v2/actions/actions/$ID/deploy \
    -X POST \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

{
  "id": "id",
  "action": {
    "id": "id",
    "all_changes_deployed": true,
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "supported_triggers": [
      {
        "id": "post-login",
        "binding_policy": "trigger-bound",
        "compatible_triggers": [
          {
            "id": "post-login",
            "version": "version"
          }
        ],
        "default_runtime": "default_runtime",
        "runtimes": [
          "string"
        ],
        "status": "status",
        "version": "version"
      }
    ],
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "action_id": "action_id",
  "built_at": "2019-12-27T18:11:19.117Z",
  "code": "code",
  "created_at": "2019-12-27T18:11:19.117Z",
  "dependencies": [
    {
      "name": "name",
      "registry_url": "registry_url",
      "version": "version"
    }
  ],
  "deployed": true,
  "errors": [
    {
      "id": "id",
      "msg": "msg",
      "url": "url"
    }
  ],
  "number": 0,
  "runtime": "runtime",
  "secrets": [
    {
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "status": "pending",
  "supported_triggers": [
    {
      "id": "post-login",
      "binding_policy": "trigger-bound",
      "compatible_triggers": [
        {
          "id": "post-login",
          "version": "version"
        }
      ],
      "default_runtime": "default_runtime",
      "runtimes": [
        "string"
      ],
      "status": "status",
      "version": "version"
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Get Actions -> ActionsPageNumberPage<{ id, all_changes_deployed, built_at, 13 more... }>

get/actions/actions

Retrieve all actions.

Get An Action ->

Action

get/actions/actions/{id}

Retrieve an action by its ID.

Test An Action -> { payload }

post/actions/actions/{id}/test

Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.

Update An Action -> { id, all_changes_deployed, built_at, 13 more... }

patch/actions/actions/{id}

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.

Domain types

Action = { id, all_changes_deployed, built_at, 13 more... }

Actions

Executions

actions.executions

Methods

Get An Execution ->

Execution

get/actions/executions/{id}

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.

Domain types

Execution = { id, created_at, results, 3 more... }

The result of a specific execution of a trigger.

Actions

Triggers

actions.triggers

Methods

Get Triggers -> { triggers }

get/actions/triggers

Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.

Actions Triggers

Bindings

actions.triggers.bindings

Methods

Get Trigger Bindings -> BindingsPageNumberPage<

Binding

get/actions/triggers/{triggerId}/bindings

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.

Update Trigger Bindings -> { bindings }

patch/actions/triggers/{triggerId}/bindings

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.

Domain types

Binding = { id, action, created_at, 3 more... }

Binding is the associative entity joining a trigger, and an action together.

Actions

Versions

actions.versions

Methods

Roll Back To A Previous Action Version -> { id, action, action_id, 12 more... }

post/actions/actions/{actionId}/versions/{id}/deploy

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.

Get An Action S Versions -> VersionsPageNumberPage<{ id, action, action_id, 12 more... }>

get/actions/actions/{actionId}/versions

Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.

Get A Specific Version Of An Action ->

ActionVersion

get/actions/actions/{actionId}/versions/{id}

Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.

Domain types

ActionVersion = { id, action, action_id, 12 more... }