組織を検索
検索条件に一致する組織の詳細を取得します。次の操作が可能です。
- 組織の検索条件を指定
nameで検索display_nameで検索- 部分一致(
containsおよびends-with)には3文字以上が必要 - ワイルドカードを使用
qクエリパラメーターを使用すると、nameまたはdisplay_nameで指定した条件に一致する組織を取得できます。
このエンドポイントは、低レイテンシのカーソルベースページネーションでSCIMまたはLuceneのフィルター構文をサポートします。parserパラメーターで”scim”または”lucene”構文を指定します(デフォルト:“lucene”)。
結果は結果整合性があるため、最近の更新がすぐに反映されない場合があります。
ソート可能なフィールド: name、display_name、created_at(昇順のみ)。デフォルトでは挿入順(古い順)です。
承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
クエリパラメータ
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メタデータのキーと値のペアでフィルター
1000フィルター式に使用するクエリパーサー。SCIMフィルター構文には"scim"、Luceneクエリ構文には"lucene"(デフォルト)を使用します。
scim, lucene ページごとに返す結果の最大数(1~100)。デフォルトは50です。
1 <= x <= 100次の結果ページのカーソル。前のレスポンスのnextフィールドの値を使用します。
1000結果を昇順で並べ替えるフィールド名。指定しない場合は、挿入順(古いものから)がデフォルトです。 結果を昇順で並べ替えるフィールド名。指定しない場合は、挿入順(古いものから順)になります。
name, display_name, created_at