Déployer une Action

Déployer une action. Le déploiement d’une action créera une nouvelle version immuable de l’action. Si l’action est actuellement liée à un déclencheur, le système commencera immédiatement à exécuter la nouvelle version déployée de l’action. Sinon, l’action ne sera exécutée dans le cadre d’un flux qu’une fois qu’elle y sera liée.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Actions.DeployAsync(
            "id"
        );
    }

}

202

{
  "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"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

L’ID d’une action.

Réponse

202

application/json

La requête de création d’une version de l’action a été acceptée.

action · object

L’action à laquelle appartient cette version.

Show child attributes

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

L’ID de l’Action à laquelle appartient cette version.

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

L’heure à laquelle cette version a été compilée avec succès.

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

Le code source de cette version précise de l’Action.

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

L’heure à laquelle cette version a été créée.

dependencies · object[]

La liste des modules npm tiers, ainsi que leurs versions, dont dépend cette version précise.

Show child attributes

deployed · boolean · défaut: true

Indique si cette version précise est celle qui est actuellement déployée.

errors · object[]

Toutes les erreurs survenues lors de la compilation de la version.

Show child attributes

id · string · défaut: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d

L’ID unique d’une version d’Action.

modules · object[]

La liste des modules d’action et de leurs versions utilisés par cette version de l’action.

Show child attributes

number · number · défaut: 1

L’index de cette version dans la liste des versions de l’Action.

runtime · string · défaut: node22

Le runtime Node. Par exemple : node22

secrets · object[]

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

Show child attributes

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

Le statut de compilation de cette version particulière.

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

supported_triggers · object[]

La liste des triggers pris en charge par cette version. Pour le moment, une version ne peut cibler qu’un seul trigger à la fois.

Minimum array length: 1

Show child attributes

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

L’heure à laquelle une version a été mise à jour. Les versions ne sont jamais mises à jour de l’extérieur. Seul Auth0 met à jour une version d’Action pendant sa compilation.