사용자 일괄 조회(Get Users Batch) (V2)

여러 사용자 조회를 한 요청으로 실행합니다. 한 배치에 최대 500개 요청을 포함할 수 있습니다. POST 방식이지만 사용자 정보를 조회하는 작업입니다.

HTTP 요청

POST /api/v2/admin/users/getBatch

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

본문은 GetUsersBatchRequestElement의 JSON 배열이며 필수입니다. 각 항목에 사용자 ID와 선택적인 상태를 지정합니다.

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

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

[
  {
    "userId": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
    "status": "ACTIVE"
  }
]

응답

응답 형식은 GetUsersBatchResponse입니다. data는 사용자 ID를 키로 하는 맵입니다.

data의 구조

맵의 키는 UserId(string), 값은 User(object)입니다. 이 이름은 키와 값의 유형 별칭입니다.

키: Foundry 사용자 ID입니다.

attributes의 구조

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

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

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

{
  "data": {
    "0d1fe74e-2b70-4a93-9b1a-80070637788b": {
      "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"
    }
  }
}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/users/getBatch" \
	-d '[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b","status":"ACTIVE"}]'

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 = [
    {
        "userId": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
        "status": "ACTIVE"
    }
]

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetUsersBatchExample.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 GetUsersBatchExample {
    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/getBatch");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("[{\"userId\":\"0d1fe74e-2b70-4a93-9b1a-80070637788b\",\"status\":\"ACTIVE\"}]", 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/getBatch`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b","status":"ACTIVE"}]'
}).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/getBatch" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "[{`"userId`":`"0d1fe74e-2b70-4a93-9b1a-80070637788b`",`"status`":`"ACTIVE`"}]"

$response.content