グループの取得

承認

Authorization

string

header

必須

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

クエリパラメータ

connection_id

string

接続 ID でグループを絞り込みます。

name

string

名前でグループを絞り込みます。

Required string length: 1 - 128

external_id

string

外部 ID でグループを絞り込みます。

Maximum string length: 256

string

名前または外部 ID でグループを検索します。

Required string length: 1 - 256

fields

string

結果に含める、または除外する（include_fields に応じて）フィールドのカンマ区切りリストです。空の場合はすべてのフィールドを取得します

Maximum string length: 256

include_fields

boolean

指定したフィールドを含める（true）か、除外する（false）かを指定します。

page

integer

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

必須範囲: x >= 0

per_page

integer

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

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

include_totals

boolean

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

from

string

選択を開始する起点となる省略可能な ID。

take

integer

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

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

レスポンス

グループを正常に取得しました。

object[]
object

グループのメタデータを表します。メンバーの一覧は別のエンドポイントから取得します。

connection_id

string<connection-id>

このグループが属する接続の識別子（接続グループの場合）。

created_at

string<date-time>

グループが作成された日時のタイムスタンプ。

external_id

string

グループの外部識別子。SCIM の同期でよく使用されます。最大長は 256 文字です。

Maximum string length: 256

string

グループの一意の識別子（サービスによって生成）。

Required string length: 18 - 26

Pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$

name

string

グループの名前。属する接続内で一意である必要があります。使用できるのは、表示可能な ASCII 文字 1～128 文字です。

Required string length: 1 - 128

Pattern: ^[\x20-\x7E]+$

tenant_name

string

このグループが属するテナントの識別子。

Minimum string length: 3

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

updated_at

string<date-time>

グループが最後に更新された日時のタイムスタンプ。