사용자(User) API (V2)
User는 Foundry의 개인 사용자 또는 서비스 계정을 나타냅니다. 사용자 ID로 정보를 조회하거나, 이름으로 활성 사용자를 검색하고, 소속 보안 표지와 프로필 사진을 조회할 수 있습니다.
사용자 식별과 특성
id는 사용자 ID입니다. username은 인증 영역(realm) 안에서 고유하지만 이메일 주소는 여러 사용자가 공유할 수 있습니다.
realm은 사용자나 그룹이 속한 인증 영역을 식별합니다. palantir-internal-realm은 관리자가 Foundry에서 생성했으며 SSO 제공자에 연결하지 않은 사용자 및 그룹에 사용합니다.
organization은 사용자의 기본 조직 RID입니다. 타사 애플리케이션의 서비스 사용자에서는 이 값이 비어 있습니다.
attributes는 특성 이름을 키로, 문자열 목록을 값으로 갖는 맵입니다. multipass:로 시작하는 특성은 Foundry 내부용으로 예약되어 있으며 변경될 수 있습니다. 추가 특성은 관리자가 Control Panel에서 구성하고 사용자가 로그인할 때 SSO 제공자가 채울 수 있습니다.
| User 필드 | 자료형 | 필수 여부 |
|---|---|---|
id | string | 필수 |
username | string | 필수 |
givenName | string | 선택 |
familyName | string | 선택 |
email | string | 선택 |
realm | string | 필수 |
organization | string | 선택 |
status | ACTIVE 또는 DELETED | 필수 |
attributes | map<AttributeName, AttributeValues> | 선택 |
AttributeName과 AttributeValue는 문자열이며, AttributeValues는 AttributeValue의 목록입니다. 이름과 성은 각각 givenName, familyName으로 구분합니다.
조회 API 선택
| 작업 | 용도와 조건 |
|---|---|
| List Users | 상태 조건과 페이지 토큰으로 사용자 목록 조회 |
| Get User | 사용자 ID로 한 사용자 조회 |
| Get Users Batch | 한 요청에 최대 500개 사용자 조회, ID를 키로 한 결과 맵 반환 |
| Get Current User | 요청을 인증한 현재 사용자 조회 |
| Search Users | 활성 사용자의 username, 이름과 성에 대한 대소문자 비구분 접두사 검색 |
| Get Markings User | 현재 소속 보안 표지 조회, 게스트 조직의 조직 보안 표지 포함 |
| Get Profile Picture Of User | 업로드한 원래 형식의 사진 바이트 조회, 응답 Content-Type으로 유형 확인 |
검색은 삭제된 사용자를 반환하지 않습니다. 삭제된 사용자는 List Users의 include=DELETED로 조회합니다. 페이지 크기와 실제 반환 개수는 다를 수 있으므로 다음 페이지 여부는 nextPageToken으로 판단합니다.
사용자 상태와 인증에 영향을 주는 API
Delete User는 지정한 사용자를 삭제합니다.
Revoke All Tokens User는 기존 인증 토큰을 모두 무효화합니다. 활성 브라우저 세션과 장기 개발 토큰도 대상이며 브라우저에서는 재인증이 필요합니다. 호출자는 대상 조직의 사용자 관리 권한이 있어야 합니다.
OAuth2를 사용하는 타사 애플리케이션은 조회에 api:admin-read, 삭제와 전체 토큰 무효화에 api:admin-write 권한 범위를 요청합니다. 토큰과 실제 작업 권한의 관계는 API 인증을 따릅니다.