Créer une action - Auth0 Docs

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supported_triggers: [
            {
                id: "post-login",
            },
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supported_triggers: [
            {
                id: "post-login",
            },
        ],
    });
}
main();

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateActionRequestContent{
        Name: "name",
        SupportedTriggers: []*management.ActionTrigger{
            &management.ActionTrigger{
                ID: management.ActionTriggerTypeEnumPostLogin,
            },
        },
    }
    mgmt.Actions.Create(
        context.TODO(),
        request,
    )
}

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

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.CreateAsync(
            new CreateActionRequestContent {
                Name = "name",
                SupportedTriggers = new List<ActionTrigger>(){
                    new ActionTrigger {
                        Id = ActionTriggerTypeEnum.PostLogin
                    },
                }

            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ActionTrigger;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;
import com.auth0.client.mgmt.types.CreateActionRequestContent;
import java.util.Arrays;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.actions().create(
            CreateActionRequestContent
                .builder()
                .name("name")
                .supportedTriggers(
                    Arrays.asList(
                        ActionTrigger
                            .builder()
                            .id(ActionTriggerTypeEnum.POST_LOGIN)
                            .build()
                    )
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Actions\Requests\CreateActionRequestContent;
use Auth0\SDK\API\Management\Types\ActionTrigger;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->create(
    new CreateActionRequestContent([
        'name' => 'name',
        'supportedTriggers' => [
            new ActionTrigger([
                'id' => ActionTriggerTypeEnum::PostLogin->value,
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, ActionTrigger

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.actions.create(
    name="name",
    supported_triggers=[
        ActionTrigger(
            id="post-login",
        )
    ],
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.actions.create(
  name: "name",
  supported_triggers: [{
    id: "post-login"
  }]
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-action",
  "supported_triggers": [
    {
      "version": "<string>",
      "status": "<string>",
      "runtimes": [
        "<string>"
      ],
      "default_runtime": "<string>",
      "compatible_triggers": [
        {
          "version": "<string>"
        }
      ]
    }
  ],
  "code": "module.exports = () => {}",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>",
      "registry_url": "<string>"
    }
  ],
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "value": "mySecretValue"
    }
  ],
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ],
  "deploy": false
}
'

{
  "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
  "name": "my-action",
  "supported_triggers": [
    {
      "id": "post-login",
      "version": "<string>",
      "status": "<string>",
      "runtimes": [
        "<string>"
      ],
      "default_runtime": "<string>",
      "compatible_triggers": [
        {
          "id": "post-login",
          "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": "post-login",
          "version": "<string>",
          "status": "<string>",
          "runtimes": [
            "<string>"
          ],
          "default_runtime": "<string>",
          "compatible_triggers": [
            {
              "id": "post-login",
              "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": "post-login",
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "id": "post-login",
            "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": "post-login",
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "id": "post-login",
            "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
    }
  ]
}

POST

https://{tenantDomain}/api/v2

actions

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supported_triggers: [
            {
                id: "post-login",
            },
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supported_triggers: [
            {
                id: "post-login",
            },
        ],
    });
}
main();

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateActionRequestContent{
        Name: "name",
        SupportedTriggers: []*management.ActionTrigger{
            &management.ActionTrigger{
                ID: management.ActionTriggerTypeEnumPostLogin,
            },
        },
    }
    mgmt.Actions.Create(
        context.TODO(),
        request,
    )
}

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

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.CreateAsync(
            new CreateActionRequestContent {
                Name = "name",
                SupportedTriggers = new List<ActionTrigger>(){
                    new ActionTrigger {
                        Id = ActionTriggerTypeEnum.PostLogin
                    },
                }

            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ActionTrigger;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;
import com.auth0.client.mgmt.types.CreateActionRequestContent;
import java.util.Arrays;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.actions().create(
            CreateActionRequestContent
                .builder()
                .name("name")
                .supportedTriggers(
                    Arrays.asList(
                        ActionTrigger
                            .builder()
                            .id(ActionTriggerTypeEnum.POST_LOGIN)
                            .build()
                    )
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Actions\Requests\CreateActionRequestContent;
use Auth0\SDK\API\Management\Types\ActionTrigger;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->create(
    new CreateActionRequestContent([
        'name' => 'name',
        'supportedTriggers' => [
            new ActionTrigger([
                'id' => ActionTriggerTypeEnum::PostLogin->value,
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, ActionTrigger

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.actions.create(
    name="name",
    supported_triggers=[
        ActionTrigger(
            id="post-login",
        )
    ],
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.actions.create(
  name: "name",
  supported_triggers: [{
    id: "post-login"
  }]
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-action",
  "supported_triggers": [
    {
      "version": "<string>",
      "status": "<string>",
      "runtimes": [
        "<string>"
      ],
      "default_runtime": "<string>",
      "compatible_triggers": [
        {
          "version": "<string>"
        }
      ]
    }
  ],
  "code": "module.exports = () => {}",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>",
      "registry_url": "<string>"
    }
  ],
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "value": "mySecretValue"
    }
  ],
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ],
  "deploy": false
}
'

{
  "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
  "name": "my-action",
  "supported_triggers": [
    {
      "id": "post-login",
      "version": "<string>",
      "status": "<string>",
      "runtimes": [
        "<string>"
      ],
      "default_runtime": "<string>",
      "compatible_triggers": [
        {
          "id": "post-login",
          "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": "post-login",
          "version": "<string>",
          "status": "<string>",
          "runtimes": [
            "<string>"
          ],
          "default_runtime": "<string>",
          "compatible_triggers": [
            {
              "id": "post-login",
              "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": "post-login",
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "id": "post-login",
            "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": "post-login",
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "id": "post-login",
            "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
    }
  ]
}

Autorisations

Authorization

string

header

requis

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

Corps

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 et de leurs versions dont cette action dépend.

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

Show child attributes

modules

object[]

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

Show child attributes

deploy

boolean

défaut:false

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

Réponse

Action créée avec succès.

string

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

L’ID unique de l’action.

name

string

défaut:my-action

Le nom d’une action.

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

all_changes_deployed

boolean

défaut:false

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

created_at

string<date-time>

défaut:2021-01-01T00:00:00.000Z

L’heure de création de cette action.

updated_at

string<date-time>

défaut:2021-01-01T00:00:00.000Z

L’heure de la dernière mise à jour de cette action.

code

string

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

Le code source de l’action.

dependencies

object[]

La liste des modules npm tiers et de leurs versions dont cette action dépend.

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

Show child attributes

deployed_version

object

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

Show child attributes

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

status

enum<string>

défaut:built

Le statut de compilation de cette action.

Options disponibles:

pending,

building,

packaged,

built,

retrying,

failed

built_at

string<date-time>

défaut:2021-01-01T00:00:00.000Z

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

deploy

boolean

défaut:false

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

modules

object[]

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

Show child attributes