Skip to main content
GET
クライアントへの認可を検索

承認

Authorization
string
header
必須

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

クエリパラメータ

q
string

SCIMまたはLucene構文のフィルター式(parserパラメーターによって異なります)。SCIMの例:audience eq "https://api.example.com"、client_id eq "cli_abc"、subject_type eq "client"、allow_any_organization eq true、default_for eq "third_party_clients"、audience co "example" and organization_id eq "org_123"。SCIM演算子:eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or。

対応フィールド:

  • audience - オーディエンスで絞り込み(eq, ne, sw, co, ew, pr)
  • client_id - Client IDで絞り込み(eq, ne, sw, pr)
  • subject_type - サブジェクトの種類で絞り込み(eq, ne, sw, pr)
  • allow_any_organization - allow_any_organizationで絞り込み(eq, ne, pr)
  • organization_id - 組織IDで絞り込み(eq, ne, sw, pr)
  • updated_at - 最終更新日で絞り込み(eq, ne, gt, ge, lt, le, pr)
  • default_for - 既定の認可グループで絞り込み(eq, ne, sw, pr)
1つのクエリで使用できるフィルター操作は最大5個です。結果は結果整合性モデルに従うため、最近の更新が反映されない場合があります。

Maximum string length: 1000
parser
enum<string>

フィルター式に使用するクエリパーサー。SCIMフィルター構文には"scim"、Luceneクエリ構文には"lucene"(既定値)を使用します。 フィルター式に使用するクエリパーサー。SCIMフィルター構文には"scim"、Luceneクエリ構文には"lucene"(デフォルト)を使用します。

利用可能なオプション:
scim,
lucene
fields
string

レスポンスに含める、またはレスポンスから除外するフィールドのカンマ区切りリスト。include_fieldsパラメーターと併用して、フィールドの選択モードを制御します。

Maximum string length: 1000
include_fields
boolean

フィールドの選択モードを制御します。fieldsパラメーターで指定したフィールドのみを含めるにはtrueに設定します。fieldsパラメーターで指定したフィールドを除外するにはfalseに設定します。指定しない場合の既定値はtrueです。

take
integer

1ページあたりに返す結果の最大数(1-100)。既定値は50です。

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

結果の次のページを取得するためのカーソル。前のレスポンスのnextフィールドの値を使用します。

Maximum string length: 1000
sort
enum<string>

結果を昇順で並べ替えるためのフィールド名。指定しない場合は挿入順(古いものから)になります。 結果を昇順に並べ替える基準となるフィールド名。指定しない場合は挿入順(古いものから順)になります。

利用可能なオプション:
audience,
updated_at

レスポンス

クライアントへの認可を正常に取得しました。

client_grants
object[]
必須

検索条件に一致するクライアントへの認可オブジェクトの配列。

next
string

結果の次のページを取得するためのカーソル。残りの結果がない場合は省略されます。