ディレクトリのグループの取得
GET /v1/directories/{directory_id}/groups/{directory_group_id} · 権限 directories:read
ID プロバイダーがディレクトリにプロビジョニングしたグループを 1 件返します: ID、外部 ID、表示名、メンバー数。メンバーは返しません。グループのメンバーを一覧するには GET /v1/directories/{directory_id}/users?group_id=… を使用してください。
リクエスト
| フィールド | 種類 | 必須 | 説明 |
|---|---|---|---|
directory_id |
path | はい | SCIM ディレクトリ ID (dir_…)。 |
directory_group_id |
path | はい | ディレクトリグループ ID (dsg_…)。 |
リクエストボディはありません。
レスポンス
200 OK とグループ。
{
"id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a",
"external_id": "00g1a2b3c4",
"name": "Engineering",
"member_count": 12
}
エラー
| HTTP | code | 発生条件 |
|---|---|---|
| 404 | not_found |
この環境にディレクトリまたはグループが存在しない、またはグループが別のディレクトリに属します。 |
| 401 | unauthenticated |
資格情報がない、不正、または失効しています。 |
| 403 | insufficient_permissions |
資格情報に必要な権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After の期間を待ってから再試行してください。 |
| 503 | service_unavailable |
ディレクトリ同期が一時的に利用できないか、このデプロイメントで構成されていません。Retry-After の期間を待ってから再試行してください。 |
例
curl -i "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z/groups/dsg_01j9xn3p5q7r9s1t3v5w7x9y1a" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"