クライアントグラントの作成

マシン間ログインフローのクライアントグラントを作成します。詳しくは、Client Credential Flow を参照してください。

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

audience · string · 必須

このクライアントグラントのオーディエンス（API 識別子）

Minimum string length: 1

allow_all_scopes · boolean

有効な場合、リソースサーバーで設定されているすべてのスコープがこのグラントで許可されます。

allow_any_organization · boolean · デフォルト: false

有効な場合、このグラントは任意の組織で使用できます。無効な場合（デフォルト）、対象の組織にこのグラントを明示的に割り当てる必要があります。

authorization_details_types · string[]

このクライアントグラントで許可される authorization_details のタイプ。

Required string length: 1 - 255

client_id · string

クライアントの ID。

default_for · enum<string> · GA

このクライアントグラントを、指定したグループ内のすべてのクライアントのデフォルトとして適用します。指定できる値は third_party_clients のみで、これによりすべての third-party クライアントにグラントが適用されます。同じオーディエンスに対するクライアント単位のグラントが優先されます。client_id とは同時に使用できません。

利用可能なオプション: third_party_clients

organization_usage · enum<string>

このグラントで、クライアントクレデンシャル交換に組織を使用できるかどうかを定義します。

利用可能なオプション: deny, allow, require

scope · string[]

このクライアントグラントで許可されるスコープ。

Required string length: 1 - 280

subject_type · enum<string>

このクライアントグラントで許可されるアプリケーションアクセスの種類。

利用可能なオプション: client, user

レスポンス

201

application/json

クライアントグラントを正常に作成しました。

allow_all_scopes · boolean

有効な場合、リソースサーバーで設定されているすべてのスコープがこのグラントで許可されます。

allow_any_organization · boolean

有効な場合、このグラントは任意の組織で使用できます。無効な場合（デフォルト）、対象の組織にこのグラントを明示的に割り当てる必要があります。

audience · string

このクライアントグラントのオーディエンス（API 識別子）。

Minimum string length: 1

authorization_details_types · string[]

このクライアントグラントで許可される authorization_details のタイプ。

Required string length: 1 - 255

client_id · string

クライアントの ID。

default_for · enum<string> · GA

このクライアントグラントを、指定したグループ内のすべてのクライアントのデフォルトとして適用します。指定できる値は third_party_clients のみで、これによりすべての third-party クライアントにグラントが適用されます。同じオーディエンスに対するクライアント単位のグラントが優先されます。client_id とは同時に使用できません。

利用可能なオプション: third_party_clients

id · string

クライアントグラントの ID。

is_system · boolean

有効な場合、このグラントは Auth0 によって作成された特別なグラントです。直接変更または削除することはできません。

organization_usage · enum<string>

このグラントで、クライアントクレデンシャル交換に組織を使用できるかどうかを定義します。

利用可能なオプション: deny, allow, require

scope · string[]

このクライアントグラントで許可されるスコープ。

Minimum string length: 1

subject_type · enum<string>

このクライアントグラントで許可されるアプリケーションアクセスの種類。

利用可能なオプション: client, user