メインコンテンツへスキップ
PATCH
/
actions
/
actions
/
{id}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.update("id", {});
}
main();
{
  "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
  "name": "my-action",
  "supported_triggers": [
    {
      "id": "<string>",
      "version": "<string>",
      "status": "<string>",
      "runtimes": [
        "<string>"
      ],
      "default_runtime": "<string>",
      "compatible_triggers": [
        {
          "id": "<string>",
          "version": "<string>"
        }
      ],
      "binding_policy": "trigger-bound"
    }
  ],
  "all_changes_deployed": false,
  "created_at": "2021-01-01T00:00:00.000Z",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "code": "module.exports = () => {}",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>",
      "registry_url": "<string>"
    }
  ],
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "deployed_version": {
    "id": "12a3b9e6-06e6-4a29-96bf-90c82fe79a0d",
    "action_id": "910b1053-577f-4d81-a8c8-020e7319a38a",
    "code": "module.exports = () => {}",
    "dependencies": [
      {
        "name": "<string>",
        "version": "<string>",
        "registry_url": "<string>"
      }
    ],
    "deployed": true,
    "runtime": "node22",
    "secrets": [
      {
        "name": "mySecret",
        "updated_at": "2021-01-01T00:00:00.000Z"
      }
    ],
    "status": "built",
    "number": 1,
    "errors": [
      {
        "id": "<string>",
        "msg": "<string>",
        "url": "<string>"
      }
    ],
    "action": {
      "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
      "name": "my-action",
      "supported_triggers": [
        {
          "id": "<string>",
          "version": "<string>",
          "status": "<string>",
          "runtimes": [
            "<string>"
          ],
          "default_runtime": "<string>",
          "compatible_triggers": [
            {
              "id": "<string>",
              "version": "<string>"
            }
          ],
          "binding_policy": "trigger-bound"
        }
      ],
      "all_changes_deployed": false,
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-01-01T00:00:00.000Z"
    },
    "built_at": "2021-01-01T00:00:00.000Z",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z",
    "supported_triggers": [
      {
        "id": "<string>",
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "id": "<string>",
            "version": "<string>"
          }
        ],
        "binding_policy": "trigger-bound"
      }
    ],
    "modules": [
      {
        "module_id": "<string>",
        "module_name": "<string>",
        "module_version_id": "<string>",
        "module_version_number": 123
      }
    ]
  },
  "installed_integration_id": "7d2bc0c9-c0c2-433a-9f4e-86ef80270aad",
  "integration": {
    "id": "8e9fe2d0-a2fc-4c8c-9e35-dae5afadb70b",
    "catalog_id": "awesome-auth0-integration",
    "url_slug": "awesome-auth0-integration-slug",
    "partner_id": "b8575c12-8d9d-4b5c-b28e-671fe9d39029",
    "name": "Example Auth0 integration",
    "description": "An awesome Auth0 integration",
    "short_description": "Awesome Auth0 integration",
    "logo": "<string>",
    "feature_type": "action",
    "terms_of_use_url": "<string>",
    "privacy_policy_url": "<string>",
    "public_support_link": "<string>",
    "current_release": {
      "id": "<string>",
      "trigger": {
        "id": "<string>",
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "id": "<string>",
            "version": "<string>"
          }
        ],
        "binding_policy": "trigger-bound"
      },
      "semver": {
        "major": 1,
        "minor": 1
      },
      "required_secrets": [
        {
          "type": "UNSPECIFIED",
          "name": "<string>",
          "required": true,
          "optional": true,
          "label": "<string>",
          "description": "<string>",
          "default_value": "<string>",
          "placeholder": "<string>",
          "options": [
            {
              "value": "<string>",
              "label": "<string>"
            }
          ]
        }
      ],
      "required_configuration": [
        {
          "type": "UNSPECIFIED",
          "name": "<string>",
          "required": true,
          "optional": true,
          "label": "<string>",
          "description": "<string>",
          "default_value": "<string>",
          "placeholder": "<string>",
          "options": [
            {
              "value": "<string>",
              "label": "<string>"
            }
          ]
        }
      ]
    },
    "created_at": "2021-06-21T15:47:29.072Z",
    "updated_at": "2021-06-21T15:47:29.072Z"
  },
  "status": "built",
  "built_at": "2021-01-01T00:00:00.000Z",
  "deploy": false,
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ]
}

承認

​
Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

​
id
string
必須

The id of the action to update.

ボディ

​
name
string
デフォルト:my-action

The name of an action.

​
supported_triggers
object[]

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

Minimum array length: 1
​
code
string
デフォルト:module.exports = () => {}

The source code of the action.

​
dependencies
object[]

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

​
runtime
string
デフォルト:node22

The Node runtime. For example: node22, defaults to node22

​
secrets
object[]

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

​
modules
object[]

The list of action modules and their versions used by this action.

レスポンス

Action successfully updated.

​
id
string
デフォルト:910b1053-577f-4d81-a8c8-020e7319a38a

The unique ID of the action.

​
name
string
デフォルト:my-action

The name of an action.

​
supported_triggers
object[]

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

Minimum array length: 1
​
all_changes_deployed
boolean
デフォルト:false

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

​
created_at
string<date-time>
デフォルト:2021-01-01T00:00:00.000Z

The time when this action was created.

​
updated_at
string<date-time>
デフォルト:2021-01-01T00:00:00.000Z

The time when this action was updated.

​
code
string
デフォルト:module.exports = () => {}

The source code of the action.

​
dependencies
object[]

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

​
runtime
string
デフォルト:node22

The Node runtime. For example: node22, defaults to node22

​
secrets
object[]

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

​
deployed_version
object

The version of the action that is currently deployed.

​
installed_integration_id
string
デフォルト:7d2bc0c9-c0c2-433a-9f4e-86ef80270aad

installed_integration_id is the fk reference to the InstalledIntegration entity.

​
integration
object

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

​
status
enum<string>
デフォルト:built

The build status of this action.

利用可能なオプション:
pending,
building,
packaged,
built,
retrying,
failed
​
built_at
string<date-time>
デフォルト:2021-01-01T00:00:00.000Z

The time when this action was built successfully.

​
deploy
boolean
デフォルト:false

True if the action should be deployed after creation.

​
modules
object[]

The list of action modules and their versions used by this action.