디렉터리 그룹 목록 조회

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"