Créer une Action

Créer une Action. Une fois qu’une Action est créée, elle doit être déployée, puis liée à un déclencheur avant d’être exécutée dans le cadre d’un flux.

POST https://{tenantDomain}/api/v2/actions/actions

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreateActionRequestContent{
        Name: "name",
        SupportedTriggers: []*management.ActionTrigger{
            &management.ActionTrigger{
                Id: "id",
            },
        },
    }
    client.Actions.Create(
        context.TODO(),
        request,
    )
}

201

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

name · string · défaut: my-action · requis

Le nom d’une Action.

supported_triggers · object[] · requis

La liste des déclencheurs pris en charge par cette Action. Pour le moment, une Action ne peut cibler qu’un seul déclencheur à la fois.

Minimum array length: 1

Show child attributes

code · string · défaut: module.exports = () => {}

Le code source de l’Action.

dependencies · object[]

La liste des modules npm tiers, ainsi que de leurs versions, dont cette Action dépend.

Show child attributes

deploy · boolean · défaut: false

Vrai si l’Action doit être déployée après sa création.

modules · object[]

La liste des modules Action et de leurs versions utilisés par cette Action.

Show child attributes

runtime · string · défaut: node22

L’environnement d’exécution Node. Par exemple : node22; la valeur par défaut est node22

secrets · object[]

La liste des secrets inclus dans une Action ou dans une version d’une Action.

Show child attributes

Réponse

201

application/json

Action créée avec succès.

all_changes_deployed · boolean · défaut: false

Vrai si tout le contenu d’une Action a été déployé.

built_at · string<date-time> · défaut: 2021-01-01T00:00:00.000Z

La date et l’heure auxquelles cette Action a été compilée avec succès.

code · string · défaut: module.exports = () => {}

Le code source de l’Action.

created_at · string<date-time> · défaut: 2021-01-01T00:00:00.000Z

La date et l’heure de création de cette Action.

dependencies · object[]

La liste des modules npm tiers, ainsi que de leurs versions, dont cette Action dépend.

Show child attributes

deploy · boolean · défaut: false

Vrai si l’Action doit être déployée après sa création.

deployed_version · object

La version de l’Action actuellement déployée.

Show child attributes

id · string · défaut: 910b1053-577f-4d81-a8c8-020e7319a38a

L’identifiant unique de l’Action.

installed_integration_id · string · défaut: 7d2bc0c9-c0c2-433a-9f4e-86ef80270aad

installed_integration_id est la référence de clé étrangère vers l’entité InstalledIntegration.

integration · object

Une intégration définit une unité fonctionnelle autonome que les partenaires publient. Un partenaire peut créer une ou plusieurs de ces intégrations.

Show child attributes

modules · object[]

La liste des modules Action et de leurs versions utilisés par cette Action.

Show child attributes

name · string · défaut: my-action

Le nom d’une Action.

runtime · string · défaut: node22

L’environnement d’exécution Node. Par exemple : node22; la valeur par défaut est node22

secrets · object[]

La liste des secrets inclus dans une Action ou dans une version d’une Action.

Show child attributes

status · enum<string> · défaut: built

Le statut de compilation de cette Action.

Options disponibles: pending, building, packaged, built, retrying, failed

supported_triggers · object[]

La liste des déclencheurs pris en charge par cette Action. Pour le moment, une Action ne peut cibler qu’un seul déclencheur à la fois.

Minimum array length: 1

Show child attributes

updated_at · string<date-time> · défaut: 2021-01-01T00:00:00.000Z

La date et l’heure de mise à jour de cette Action.