グループの取得

ID でグループを取得します。

GET https://{tenantDomain}/api/v2/groups/{id}

グループを取得

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/groups/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "tenant_name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "connection_id": "<string>",
  "external_id": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

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

Required string length: 18 - 26

レスポンス

200

application/json

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

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

created_at · string<date-time> · 必須

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

id · string · 必須

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

Required string length: 18 - 26

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

name · string · 必須

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

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> · 必須

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

connection_id · string<connection-id>

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

external_id · string

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

Maximum string length: 256