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パラメーターに応じて指定。デフォルトはLucene)。Luceneの例:name:acme*、display_name:*auth*。SCIMの例:name eq "Auth0"、display_name sw "auth" and created_at gt "2024-01-01"。SCIM演算子:eq、ne、sw、ew、co、pr、gt、ge、lt、le、and、or。

サポートされるフィールド:

  • id - Organization ID(大文字と小文字を区別する完全一致)
  • name - Organization名(contains、starts-with、ends-with演算子をサポート、ソート可能)
  • display_name - Organizationの表示名(contains、starts-with、ends-with演算子をサポート、ソート可能)
  • created_at - 作成日時(日付範囲演算子をサポート、ソート可能)
  • metadata.{key} - Organizationメタデータのキーと値のペアでフィルター
クエリごとに使用できるフィルター操作は最大5つです。結果は結果整合性があるため、最近の更新が反映されない場合があります。

Maximum string length: 1000
parser
enum<string>

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

利用可能なオプション:
scim,
lucene
take
integer

ページごとに返す結果の最大数(1~100)。デフォルトは50です。

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

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

Maximum string length: 1000
sort
enum<string>

結果を昇順で並べ替えるフィールド名。指定しない場合は、挿入順(古いものから)がデフォルトです。 結果を昇順で並べ替えるフィールド名。指定しない場合は、挿入順(古いものから順)になります。

利用可能なオプション:
name,
display_name,
created_at

レスポンス

Organizationsを正常に取得しました。

organizations
object[]
必須

検索条件に一致する Organization オブジェクトの配列。

next
string

結果の次のページを取得するためのカーソル。これ以上結果がない場合は含まれません。