Auth0 API | Actions › Create 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.

Security

Example: Authorization: Bearer My Bearer Token

Response fields

id: string

Optional

The unique ID of the action.

all_changes_deployed: boolean

Optional

True if all of an Action's contents have been deployed.

built_at: string

Optional

(format: date-time)

The time when this action was built successfully.

code: string

Optional

The source code of the action.

created_at: string

Optional

(format: date-time)

The time when this action was created.

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

Optional

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

deploy: boolean

Optional

True if the action should be deployed after creation.

deployed_version: Record<string, unknown>

Optional

The version of the action that is currently deployed.

installed_integration_id: string

Optional

installed_integration_id is the fk reference to the InstalledIntegration entity.

integration: { id, catalog_id, created_at, 12 more... }

Optional

Integration defines a self contained functioning unit which partners publish. A partner may create one or many of these integrations.

name: string

Optional

The name of an action.

runtime: string

Optional

The Node runtime. For example: node12, defaults to 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 action.

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

Optional

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

updated_at: string

Optional

(format: date-time)

The time when this action was updated.

Request example

curl https://login0.local.dev.auth0.com/api/v2/actions/actions \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEARER_TOKEN" \
    -d '{
      "name": "name",
      "supported_triggers": [
        {
          "id": "post-login"
        }
      ]
    }'

200Example

{
  "id": "id",
  "all_changes_deployed": true,
  "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"
    }
  ],
  "deploy": true,
  "deployed_version": {
    "foo": "bar"
  },
  "installed_integration_id": "installed_integration_id",
  "integration": {
    "id": "id",
    "catalog_id": "catalog_id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "current_release": {
      "id": "id",
      "required_configuration": [
        {
          "default_value": "default_value",
          "description": "description",
          "label": "label",
          "name": "name",
          "optional": true,
          "options": [
            {
              "label": "label",
              "value": "value"
            }
          ],
          "placeholder": "placeholder",
          "required": true,
          "type": "UNSPECIFIED"
        }
      ],
      "required_secrets": [
        {
          "default_value": "default_value",
          "description": "description",
          "label": "label",
          "name": "name",
          "optional": true,
          "options": [
            {
              "label": "label",
              "value": "value"
            }
          ],
          "placeholder": "placeholder",
          "required": true,
          "type": "UNSPECIFIED"
        }
      ],
      "semver": {
        "major": 0,
        "minor": 0
      },
      "trigger": {
        "id": "post-login",
        "binding_policy": "trigger-bound",
        "compatible_triggers": [
          {
            "id": "post-login",
            "version": "version"
          }
        ],
        "default_runtime": "default_runtime",
        "runtimes": [
          "string"
        ],
        "status": "status",
        "version": "version"
      }
    },
    "description": "description",
    "feature_type": "unspecified",
    "logo": "logo",
    "name": "name",
    "partner_id": "partner_id",
    "privacy_policy_url": "privacy_policy_url",
    "public_support_link": "public_support_link",
    "short_description": "short_description",
    "terms_of_use_url": "terms_of_use_url",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "url_slug": "url_slug"
  },
  "name": "name",
  "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"
}

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.

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... }