クライアントグラントを取得

アプリケーションと API の組み合わせに関連付けられた scopes を含む、client grants の一覧を取得します。

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

C#

C#

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.ListAsync(
            new ListClientGrantsRequestParameters {
                From = "from",
                Take = 1,
                Audience = "audience",
                ClientId = "client_id",
                AllowAnyOrganization = true,
                SubjectType = ClientGrantSubjectTypeEnum.Client,
                DefaultFor = ClientGrantDefaultForEnum.ThirdPartyClients
            }
        );
    }

}

200

[
  {
    "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.

クエリパラメータ

per_page · integer

1 ページあたりの結果数。

必須範囲: 1 <= x <= 100

page · integer

返される結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

include_totals · boolean

結果を、総結果数を含むオブジェクトとして返す（true）か、結果の配列を直接返す（false、デフォルト）かを指定します。

from · string

選択を開始する起点となる任意の Id。

take · integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: 1 <= x <= 100

audience · string

audience による任意のフィルター。

client_id · string

client_id による任意のフィルター。

allow_any_organization · enum<boolean>

allow_any_organization による任意のフィルター。 allow_any_organization に対するオプションのフィルター。

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

subject_type · enum<string>

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

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

default_for · enum<string> · GA

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

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

レスポンス

200

application/json

client grants が正常に取得されました。

Option 1 · object[]

Option 2 · object

Option 3 · object

allow_all_scopes · boolean

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

allow_any_organization · boolean

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

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> · GA

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

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

id · string

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

is_system · boolean

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

organization_usage · enum<string>

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

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

scope · string[]

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

Minimum string length: 1

subject_type · enum<string>

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

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