Déployer la version brouillon

Effectue l’équivalent d’un retour à une version antérieure précise d’une action. Crée une nouvelle version d’action déployée identique à la version indiquée. Si cette action est actuellement liée à un déclencheur, le système commencera immédiatement à exécuter la nouvelle version créée.

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

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.DeployActionVersionRequestBodyParams{}
    client.Actions.Versions.Deploy(
        context.TODO(),
        "actionId",
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.versions.deploy("actionId", "id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.versions.deploy("actionId", "id", {});
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "update_draft": false
}
'

import requests

url = "https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy"

payload = { "update_draft": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'update_draft' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"update_draft\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"update_draft\": false\n}"

response = http.request(request)
puts response.read_body

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 version d'action.

actionId · string · requis

L'ID d'une action.

Corps

application/jsonapplication/x-www-form-urlencoded

update_draft · boolean · défaut: false

True si le brouillon de l’Action doit être mis à jour avec la version rétablie.

Réponse

202

application/json

La demande de création d'une version d'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 de 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 pendant 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 Action et de leurs versions utilisés par cette version d’Action.

Show child attributes

number · number · défaut: 1

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

runtime · string · défaut: node22

L’environnement d’exécution Node. Par exemple : node22

secrets · object[]

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

Show child attributes

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

Le statut de génération de cette version précise.

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

supported_triggers · object[]

La liste des déclencheurs pris en charge par cette version. Pour le moment, une version 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 auxquelles 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 création.