Créer des autorisations d’application

Créez une autorisation d’application pour un flux de connexion d’application machine à machine. Pour en savoir plus, consultez le flux d’informations d’identification du client.

POST https://{tenantDomain}/api/v2/client-grants

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.CreateClientGrantRequestContent{
        ClientId: "client_id",
        Audience: "audience",
        Scope: []string{
            "scope",
        },
    }
    client.ClientGrants.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.clientGrants.create({
        clientId: "client_id",
        audience: "audience",
        scope: [
            "scope",
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.clientGrants.create({
        clientId: "client_id",
        audience: "audience",
        scope: [
            "scope",
        ],
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/client-grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience": "<string>",
  "allow_all_scopes": true,
  "allow_any_organization": false,
  "authorization_details_types": [
    "<string>"
  ],
  "client_id": "<string>",
  "default_for": "third_party_clients",
  "scope": [
    "<string>"
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/client-grants"

payload = {
    "audience": "<string>",
    "allow_all_scopes": True,
    "allow_any_organization": False,
    "authorization_details_types": ["<string>"],
    "client_id": "<string>",
    "default_for": "third_party_clients",
    "scope": ["<string>"]
}
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/client-grants",
  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([
    'audience' => '<string>',
    'allow_all_scopes' => true,
    'allow_any_organization' => false,
    'authorization_details_types' => [
        '<string>'
    ],
    'client_id' => '<string>',
    'default_for' => 'third_party_clients',
    'scope' => [
        '<string>'
    ]
  ]),
  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/client-grants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audience\": \"<string>\",\n  \"allow_all_scopes\": true,\n  \"allow_any_organization\": false,\n  \"authorization_details_types\": [\n    \"<string>\"\n  ],\n  \"client_id\": \"<string>\",\n  \"default_for\": \"third_party_clients\",\n  \"scope\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/client-grants")

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  \"audience\": \"<string>\",\n  \"allow_all_scopes\": true,\n  \"allow_any_organization\": false,\n  \"authorization_details_types\": [\n    \"<string>\"\n  ],\n  \"client_id\": \"<string>\",\n  \"default_for\": \"third_party_clients\",\n  \"scope\": [\n    \"<string>\"\n  ]\n}"

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

201

{
  "allow_all_scopes": true,
  "allow_any_organization": true,
  "audience": "<string>",
  "authorization_details_types": [
    "<string>"
  ],
  "client_id": "<string>",
  "default_for": "third_party_clients",
  "id": "<string>",
  "is_system": true,
  "scope": [
    "<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

audience · string · requis

L’audience (identifiant d’API) de cette autorisation d’application

Minimum string length: 1

allow_all_scopes · boolean

Si cette option est activée, tous les scopes configurés sur le serveur de ressources sont autorisés pour cet octroi.

allow_any_organization · boolean · défaut: false

Si cet octroi est activé, n’importe quelle organisation peut être utilisée avec celui-ci. S’il est désactivé (par défaut), il doit être explicitement attribué aux organisations souhaitées.

authorization_details_types · string[]

Types de authorization_details autorisés pour cette autorisation d’application.

Required string length: 1 - 255

client_id · string

ID de l’application.

default_for · enum<string> · GA

Applique cette autorisation d’application par défaut à toutes les applications du groupe spécifié. La seule valeur acceptée est third_party_clients, qui applique l’autorisation à toutes les applications tierces. Les autorisations propres à l’application pour la même audience ont priorité. S’exclut mutuellement avec client_id.

Options disponibles: third_party_clients

organization_usage · enum<string>

Définit si les organisations peuvent être utilisées avec des échanges Client Credentials pour cet octroi.

Options disponibles: deny, allow, require

scope · string[]

Scopes autorisés pour cette autorisation d’application.

Required string length: 1 - 280

subject_type · enum<string>

Le type d’accès à l’application autorisé par cette autorisation d’application.

Options disponibles: client, user

Réponse

201

application/json

Autorisation d’application créée avec succès.

allow_all_scopes · boolean

Si cette option est activée, tous les scopes configurés sur le serveur de ressources sont autorisés pour cet octroi.

allow_any_organization · boolean

Si cet octroi est activé, n’importe quelle organisation peut être utilisée avec celui-ci. S’il est désactivé (par défaut), il doit être explicitement attribué aux organisations souhaitées.

audience · string

L’audience (identifiant d’API) de cette autorisation d’application.

Minimum string length: 1

authorization_details_types · string[]

Types de authorization_details autorisés pour cette autorisation d’application.

Required string length: 1 - 255

client_id · string

ID de l’application.

default_for · enum<string> · GA

Applique cette autorisation d’application par défaut à toutes les applications du groupe spécifié. La seule valeur acceptée est third_party_clients, qui applique l’autorisation à toutes les applications tierces. Les autorisations propres à l’application pour la même audience ont priorité. S’exclut mutuellement avec client_id.

Options disponibles: third_party_clients

id · string

ID de l’autorisation d’application.

is_system · boolean

Si cette option est activée, cet octroi est un octroi spécial créé par Auth0. Il ne peut pas être modifié ni supprimé directement.

organization_usage · enum<string>

Définit si les organisations peuvent être utilisées avec des échanges Client Credentials pour cet octroi.

Options disponibles: deny, allow, require

scope · string[]

Scopes autorisés pour cette autorisation d’application.

Minimum string length: 1

subject_type · enum<string>

Le type d’accès à l’application autorisé par cette autorisation d’application.

Options disponibles: client, user