ディレクトリのグループの一覧

GET /v1/directories/{directory_id}/groups · 権限 directories:read

IDプロバイダーがディレクトリにプロビジョニングしたグループを、ID順に一覧します。ID、外部ID、表示名、メンバー数を返し、メンバーは決して返しません。グループの id は POST /v1/directories/{directory_id}/role-mappings の directory_group_id として使用します。前方へのページングのみ対応し、カーソルはディレクトリに紐づきます。

リクエスト

フィールド 型 必須 説明
directory_id path はい SCIMディレクトリID（dir_…）。
limit query いいえ 1〜100、既定値 20。
after query いいえ list_metadata.after のカーソル。

リクエストボディはありません。

レスポンス

200 OK とグループのページを返します。

{
  "data": [
    {
      "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a",
      "external_id": "00g1a2b3c4",
      "name": "Engineering",
      "member_count": 12
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

エラー

HTTP code 発生条件
400 invalid_cursor カーソルが無効、または別のディレクトリもしくはフィルターのものです。
404 not_found ディレクトリがこの環境に存在しません。
422 validation_failed limit が範囲外、または before か order が指定されました（unsupported）。
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?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"