조직 조회(Get Organization) (V2)
조직 RID로 이름, 기본 호스트와 기반 보안 표지 ID를 조회합니다. 조직 리소스의 rid와 게스트 접근 관리에 사용하는 markingId는 서로 다른 식별자입니다.
HTTP 요청
GET /api/v2/admin/organizations/{organizationRid}
작업 식별자는 v2.getOrganization입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
organizationRid | string | 필수 | ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 Organization입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
rid | string | 필수 | ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa | |
name | string | 필수 | Example Organization | |
description | string | 선택 | ||
markingId | string | 필수 | 조직의 기반 보안 표지 ID입니다. 이 표지의 구성원을 변경해 조직의 게스트 접근을 관리할 수 있습니다. | 18212f9a-0e63-4b79-96a0-aae04df23336 |
host | string | 선택 | 조직의 기본 호스트 이름입니다. 이 조직 사용자를 위한 URL을 만들 때 사용합니다. | example.palantirfoundry.com |
가상 조직의 응답 예시입니다.
{
"name": "Example Organization",
"host": "example.palantirfoundry.com",
"rid": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
"markingId": "18212f9a-0e63-4b79-96a0-aae04df23336"
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
OrganizationNotFound | NOT_FOUND | 404 | 지정한 조직을 찾을 수 없습니다. | organizationRid |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"authorization": "Bearer {}".format(TOKEN)
}
response = requests.get('https://{}/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetOrganizationExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
public class GetOrganizationExample {
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()) {
HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
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/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${TOKEN}`,
}
}).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/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" `
-Headers $headers
$response.content