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

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

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.ClientGrants.CreateAsync(
            new CreateClientGrantRequestContent {
                Audience = "audience"
            }
        );
    }

}

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateClientGrantRequestContent;

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

        client.clientGrants().create(
            CreateClientGrantRequestContent
                .builder()
                .audience("audience")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ClientGrants\Requests\CreateClientGrantRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clientGrants->create(
    new CreateClientGrantRequestContent([
        'audience' => 'audience',
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>"
  ]
}
'

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

POST

https://{tenantDomain}/api/v2

client-grants

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

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.ClientGrants.CreateAsync(
            new CreateClientGrantRequestContent {
                Audience = "audience"
            }
        );
    }

}

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateClientGrantRequestContent;

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

        client.clientGrants().create(
            CreateClientGrantRequestContent
                .builder()
                .audience("audience")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ClientGrants\Requests\CreateClientGrantRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clientGrants->create(
    new CreateClientGrantRequestContent([
        'audience' => 'audience',
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>"
  ]
}
'

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

承認

Authorization

string

header

必須

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

ボディ

audience

string

必須

このクライアントグラントの audience（API 識別子）

Minimum string length: 1

allow_all_scopes

boolean

有効にすると、このグラントではリソースサーバーに設定されているすべての scopes が許可されます。

allow_any_organization

boolean

デフォルト:false

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

authorization_details_types

string[]

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

Required string length: 1 - 255

client_id

string

クライアントの ID。

default_for

enum<string>

このクライアントグラントを、指定したグループ内のすべてのクライアントに対するデフォルトとして適用します。指定できる値は third_party_clients のみで、すべてのサードパーティクライアントにこのグラントを適用します。同じ audience に対するクライアントごとのグラントが優先されます。client_id とは相互排他的です。

利用可能なオプション:

third_party_clients

organization_usage

enum<string>

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

利用可能なオプション:

deny,

allow,

require

scope

string[]

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

Required string length: 1 - 280

subject_type

enum<string>

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

利用可能なオプション:

client,

user,

anonymous_user

レスポンス

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

allow_all_scopes

boolean

有効にすると、このグラントではリソースサーバーに設定されているすべての scopes が許可されます。

allow_any_organization

boolean

audience

string

このクライアントグラントの audience（API 識別子）。

Minimum string length: 1

authorization_details_types

string[]

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

Required string length: 1 - 255

client_id

string

クライアントの ID。

default_for

enum<string>

利用可能なオプション:

third_party_clients

string

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

is_system

boolean

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

organization_usage

enum<string>

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

利用可能なオプション:

deny,

allow,

require

scope

string[]

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

Minimum string length: 1

subject_type

enum<string>

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

利用可能なオプション:

client,

user,

anonymous_user