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

アプリケーション/API の組み合わせに関連付けられたスコープを含む、クライアントグラントの一覧を取得します。

GET 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.ListClientGrantsRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Audience: management.String(
            "audience",
        ),
        ClientId: management.String(
            "client_id",
        ),
        AllowAnyOrganization: management.Bool(
            true,
        ),
    }
    client.ClientGrants.List(
        context.TODO(),
        request,
    )
}

200

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

返される結果のページインデックス。最初のページは 0 です。

必須範囲: x >= 0

include_totals · boolean

結果を、合計件数を含むオブジェクトとして返すか（true）、結果の配列を直接返すか（false、既定）を指定します。

from · string

選択を開始する開始 id（省略可能）。

take · integer

1 ページあたりの結果数。既定値は 50 です。

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

audience · string

オーディエンスで絞り込むための省略可能なフィルター。

client_id · string

client_id で絞り込むための省略可能なフィルター。

allow_any_organization · enum<boolean>

allow_any_organization で絞り込むための省略可能なフィルター。 allow_any_organization に対するオプションのフィルター。

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

subject_type · enum<string>

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

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

default_for · enum<string> · GA

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

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

レスポンス

200

application/json

クライアントグラントを正常に取得しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

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