組織のクライアントグラントを取得する

GET https://{tenantDomain}/api/v2/organizations/{id}/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"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.ListOrganizationClientGrantsRequestParameters{
        Audience: management.String(
            "audience",
        ),
        ClientId: management.String(
            "client_id",
        ),
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Organizations.ClientGrants.List(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "allow_any_organization": true,
    "audience": "<string>",
    "client_id": "<string>",
    "id": "<string>",
    "scope": [
      "<string>"
    ]
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

組織の識別子。

Maximum string length: 50

クエリパラメータ

audience · string

クライアントグラントのオーディエンスで絞り込むための任意のフィルター。

Maximum string length: 600

client_id · string

クライアントグラントの client_id で絞り込むための任意のフィルター。

grant_ids · string<client-grant-id>[]

クライアントグラントのIDで絞り込むための任意のフィルター。URL エンコードする必要があり、複数回指定できます（最大 10 回）。
例: ../client-grants?grant_ids=id1&grant_ids=id2

page · integer

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

必須範囲: x >= 0

per_page · integer

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

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

include_totals · boolean

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

レスポンス

200

application/json

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

object[]

object

allow_any_organization · boolean

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

audience · string

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

Minimum string length: 1

client_id · string

クライアントの ID。

id · string

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

organization_usage · enum<string>

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

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

scope · string[]

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

Minimum string length: 1