사용자 검색(Search Users) (V2)

활성 사용자의 username, 이름과 성을 대상으로 대소문자를 구분하지 않는 접두사 검색을 수행합니다. 삭제된 사용자는 검색 결과에 포함하지 않습니다. 삭제된 사용자를 찾으려면 사용자 목록 조회에서 include=DELETED를 지정합니다.

검색 조건은 where.type="queryString"과 검색어인 where.value로 지정합니다. 첫 페이지에서는 pageToken을 생략하고, 계속 조회할 때 직전 응답의 nextPageToken을 사용합니다.

HTTP 요청

POST /api/v2/admin/users/search

작업 식별자는 v2.searchUsers입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

본문은 필수 SearchUsersRequest JSON 객체입니다. where는 필수이며 페이지 크기와 토큰은 선택사항입니다.

where의 구조

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "pageSize": 100,
  "where": {
    "type": "queryString",
    "value": "jsmith"
  },
  "pageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

응답

응답 형식은 SearchUsersResponse입니다.

data의 구조

배열 항목은 User이며 자료형은 object입니다.

attributes의 구조

맵의 키는 AttributeName(string), 값은 AttributeValues(list<AttributeValue>)입니다. 이 이름은 키와 값의 유형 별칭입니다.

배열 항목은 AttributeValue이며 자료형은 string입니다.

가상 사용자를 대상으로 한 응답 예시입니다.

{
  "data": [
    {
      "givenName": "John",
      "familyName": "Smith",
      "organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
      "realm": "palantir-internal-realm",
      "attributes": {
        "multipass:givenName": [
          "John"
        ],
        "multipass:familyName": [
          "Smith"
        ],
        "multipass:email:primary": [
          "jsmith@example.com"
        ],
        "multipass:realm": [
          "eab0a251-ca1a-4a84-a482-200edfb8026f"
        ],
        "multipass:organization-rid": [
          "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
        ],
        "department": [
          "Finance"
        ],
        "jobTitle": [
          "Accountant"
        ]
      },
      "id": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
      "email": "jsmith@example.com",
      "username": "jsmith",
      "status": "ACTIVE"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

검색 예제의 pageToken은 계속 조회를 나타내는 가상 값입니다. 다음 페이지를 조회할 때는 직전 응답의 실제 nextPageToken으로 바꾸고, 첫 요청에서는 본문의 pageToken 항목을 제거합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/users/search" \
	-d '{"pageSize":100,"where":{"type":"queryString","value":"jsmith"},"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "pageSize": 100,
    "where": {
        "type": "queryString",
        "value": "jsmith"
    },
    "pageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

response = requests.post('https://{}/api/v2/admin/users/search'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 SearchUsersExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class SearchUsersExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/admin/users/search");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"pageSize\":100,\"where\":{\"type\":\"queryString\",\"value\":\"jsmith\"},\"pageToken\":\"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z\"}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/admin/users/search`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"pageSize":100,"where":{"type":"queryString","value":"jsmith"},"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/admin/users/search" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"pageSize`":100,`"where`":{`"type`":`"queryString`",`"value`":`"jsmith`"},`"pageToken`":`"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z`"}"

$response.content