디렉터리 사용자 조회

GET /v1/directories/{directory_id}/users · 권한 directories:read

아이덴티티 공급자가 디렉터리에 프로비저닝한 활성 사용자 레코드를 ID 순으로 조회합니다. 정규화된 속성, 사용자의 디렉터리 그룹, 환경 사용자와의 연결 정보, 불일치(drift) 플래그를 포함합니다. 삭제된 레코드는 반환되지 않습니다. state와 group_id 필터는 함께 사용할 수 있습니다. 앞으로 가는 페이지 나누기만 지원되며, 커서는 디렉터리와 필터에 바인딩됩니다.

users:read_pii 권한이 없는 자격 증명은 마스킹된 개인정보를 받습니다. user_name은 첫 글자와 ***로, emails[].value는 a***@e***.com 형식으로, given_name, family_name, display_name은 이니셜로, attributes는 null로 반환됩니다. external_id, locale, zoneinfo, 그룹, ID는 마스킹되지 않습니다. 시크릿 키는 모든 권한을 갖습니다.

요청

필드	유형	필수	설명
`directory_id`	path	예	SCIM 디렉터리 ID(`dir_…`)입니다.
`state`	query	아니요	이 상태의 사용자만 조회합니다: `active`, `inactive` 또는 `held`(대량 비활성화 보류 중).
`group_id`	query	아니요	이 디렉터리 그룹(`dsg_…`)의 구성원만 조회합니다. 다른 디렉터리의 그룹이면 빈 페이지가 반환됩니다.
`limit`	query	아니요	1~100, 기본값 20입니다.
`after`	query	아니요	`list_metadata.after`의 커서입니다.

요청 본문은 없습니다.

응답

디렉터리 사용자 페이지와 함께 200 OK를 반환합니다.

{
  "data": [
    {
      "id": "dsu_01j9xp4q6r8s0t2v4w6x8y0z2b",
      "directory_id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
      "external_id": "00u1a2b3c4",
      "user_name": "jane@example.com",
      "emails": [{ "value": "jane@example.com", "primary": true }],
      "given_name": "Jane",
      "family_name": "Doe",
      "display_name": "Jane Doe",
      "locale": "en-US",
      "zoneinfo": "Europe/Berlin",
      "state": "active",
      "attributes": { "department": "Engineering" },
      "groups": [{ "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a", "name": "Engineering" }],
      "user_id": "usr_01j9xq5r7s9t1v3w5x7y9z1a3c",
      "link_status": "linked",
      "drift": false,
      "created_at": "2026-10-20T09:00:00Z",
      "updated_at": "2026-10-20T09:05:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

link_status는 linked, invited, blocked_other_org, duplicate, mirror_only, unlinked 중 하나입니다. 레코드가 연결되지 않은 경우 user_id는 null입니다. 빈 값은 null로 표시됩니다.

오류

HTTP	code	발생 조건
400	`invalid_cursor`	커서가 잘못되었거나 다른 디렉터리 또는 필터에 속합니다.
404	`not_found`	이 환경에 디렉터리가 존재하지 않습니다.
422	`validation_failed`	`state` 또는 `group_id`가 잘못되었거나 반복되었거나, `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/users?state=active&limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

개인정보

이 엔드포인트에는 개인정보, 즉 디렉터리(SCIM) 사용자 정보가 포함됩니다. KeenAuth API의 개인정보에서 저장되는 항목, 보관 기간, 삭제 방법을 확인하십시오. 어떤 필드에도 민감한 개인정보(건강, 생체 정보, 종교, 정치적 견해, 성적 지향)를 보내지 마십시오.