그룹(Group) API (V2)
Group은 사용자, 다른 그룹 또는 둘 다 포함할 수 있는 컬렉션입니다. 이 API는 그룹의 기본 정보와 특성을 관리하고 전체 목록, ID별 정보 또는 현재 사용자의 소속 그룹을 조회합니다.
그룹 모델
| 필드 | 자료형 | 의미 |
|---|---|---|
id | string | 그룹 ID |
name | string | 그룹 이름 |
description | string | 선택적인 그룹 설명 |
realm | string | 그룹이 속한 인증 영역 |
organizations | list<OrganizationRid> | 구성원들이 이 그룹을 볼 수 있는 조직 범위 |
attributes | map<AttributeName, AttributeValues> | 그룹 특성 맵 |
id, name, realm은 응답의 필수 필드입니다. 나머지 필드는 선택 필드입니다. OrganizationRid, AttributeName, AttributeValue는 문자열이며 AttributeValues는 문자열 목록입니다.
organizations는 그룹의 멤버 목록이 아닙니다. 이 그룹을 볼 수 있는 조직의 RID를 지정하며, 그룹 생성과 교체 요청에는 최소 하나의 조직 RID가 필요합니다.
palantir-internal-realm은 관리자가 Foundry에서 생성했으며 SSO 제공자와 연결하지 않은 사용자 및 그룹에 사용합니다. multipass:로 시작하는 특성은 내부용으로 예약되어 있고 변경될 수 있습니다.
조회 작업
| API | 용도와 조건 |
|---|---|
| List Groups | 그룹 목록을 페이지 단위로 조회 |
| Get Group | ID로 한 그룹의 정보 조회 |
| Get Groups Batch | 최대 500개 조회를 한 요청으로 실행, 그룹 ID를 키로 한 결과 맵 반환 |
| Search Groups | 그룹 이름의 대소문자 비구분 접두사 검색 |
| List Current Groups | 현재 사용자가 직접 또는 간접 구성원인 그룹 전체 조회 |
페이지당 실제 결과 수는 요청한 크기와 다를 수 있습니다. 다음 페이지가 있는지는 nextPageToken으로 판단합니다.
List Current Groups는 미리보기 API이므로 preview=true가 필요하며 언제든 변경되거나 제거될 수 있습니다. 다른 관리 조회 API와 달리 특정 OAuth 권한 범위 없이 인증된 사용자가 자기 소속 그룹을 조회할 수 있습니다.
생성, 교체와 삭제
- Create Group은 새 그룹을 만듭니다.
- Replace Group은 그룹 정보를 교체합니다. 먼저 Get Group을 호출하고 모든
multipass:특성을 조회한 값 그대로 다시 전달합니다. - Delete Group은 지정한 그룹을 삭제합니다.
OAuth2를 사용하는 타사 애플리케이션은 일반 조회에 api:admin-read, 변경 작업에 api:admin-write 권한 범위를 요청합니다. List Current Groups의 예외는 위 조건을 따릅니다.