Créer des Hooks

Crée un Hook.

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

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.CreateHookRequestContent{
        Name: "name",
        Script: "script",
        TriggerId: management.HookTriggerIdEnumCredentialsExchange,
    }
    client.Hooks.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-hook",
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "dependencies": {},
  "enabled": false
}
'

import requests

url = "https://{tenantDomain}/api/v2/hooks"

payload = {
    "name": "my-hook",
    "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
    "dependencies": {},
    "enabled": 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/hooks",
  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([
    'name' => 'my-hook',
    'script' => 'module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };',
    'dependencies' => [
        
    ],
    'enabled' => 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/hooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-hook\",\n  \"script\": \"module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };\",\n  \"dependencies\": {},\n  \"enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/hooks")

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  \"name\": \"my-hook\",\n  \"script\": \"module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };\",\n  \"dependencies\": {},\n  \"enabled\": false\n}"

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

201

{
  "dependencies": {},
  "enabled": true,
  "id": "00001",
  "name": "hook",
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "triggerId": "<string>"
}

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-hook · requis

Nom de ce hook.

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$

script · string · défaut: module.exports = function(client, scope, audience, context, cb) cb(null, access_token); }; · requis

Code à exécuter lorsque ce hook est exécuté.

Minimum string length: 1

triggerId · enum<string> · requis

Étape d’exécution de cette Rule. Peut être credentials-exchange, pre-user-registration, post-user-registration, post-change-password ou send-phone-message.

Options disponibles: credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message

dependencies · object

Dépendances de ce hook utilisées par le serveur Webtask.

Show child attributes

enabled · boolean · défaut: false

Indique si ce hook sera exécuté (true) ou ignoré (false).

Réponse

201

application/json

Hook créé avec succès.

dependencies · object

Dépendances de ce hook utilisées par le serveur Webtask.

Show child attributes

enabled · boolean · défaut: true

Indique si ce hook sera exécuté (true) ou ignoré (false).

id · string · défaut: 00001

ID de ce hook.

name · string · défaut: hook

Nom de ce hook.

script · string · défaut: module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

Code à exécuter lorsque ce hook est exécuté.

triggerId · string

ID du déclencheur