Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

조직 생성(Create Organization) (V2)

지정한 플랫폼 인스턴스에 조직을 만들고 초기 관리자를 설정합니다. enrollmentRid와 name을 제공하고 관리자 주체를 최소 하나 지정해야 합니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

POST /api/v2/admin/organizations

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

경로 매개변수

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

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

본문은 필수 CreateOrganizationRequest 객체입니다. administrators는 형식 스키마에서 선택 배열이지만 조직 생성 조건상 주체 ID를 최소 하나 포함해야 합니다.

이름자료형필수 여부의미와 조건예시 값
administratorslist<PrincipalId>선택조직의 초기 관리자입니다. 사용자 또는 그룹 주체를 최소 하나 지정해야 합니다.
enrollmentRidstring필수조직이 속할 플랫폼 인스턴스의 RID이며 반드시 제공해야 합니다.ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6
namestring필수Example Organization
hoststring선택조직의 기본 호스트 이름입니다. 이 조직 사용자를 위한 URL을 만들 때 사용합니다.example.palantirfoundry.com
descriptionstring선택

administrators의 구조

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

Foundry 그룹 또는 사용자의 ID입니다.

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

{
  "enrollmentRid": "ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6",
  "name": "Example Organization",
  "host": "example.palantirfoundry.com",
  "administrators": [
    "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
  ]
}

응답

응답 형식은 Organization입니다.

생성한 조직입니다.

이름자료형필수 여부의미와 조건예시 값
ridstring필수ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa
namestring필수Example Organization
descriptionstring선택
markingIdstring필수조직의 기반 보안 표지 ID입니다. 이 표지의 구성원을 변경해 조직의 게스트 접근을 관리할 수 있습니다.18212f9a-0e63-4b79-96a0-aae04df23336
hoststring선택조직의 기본 호스트 이름입니다. 이 조직 사용자를 위한 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의미와 조건추가 매개변수
CreateOrganizationMissingInitialAdminRoleINVALID_ARGUMENT400조직을 만들 때 organization:administrator 역할을 받을 초기 주체를 최소 하나 지정해야 합니다.
OrganizationNameAlreadyExistsINVALID_ARGUMENT400같은 이름의 조직이 이미 있습니다.displayName
PrincipalNotFoundNOT_FOUND404지정한 PrincipalId의 사용자 또는 그룹을 찾을 수 없습니다.principalId
CreateOrganizationPermissionDeniedPERMISSION_DENIED403조직 생성 권한이 거부되었습니다.
EnrollmentNotFoundNOT_FOUND404지정한 플랫폼 인스턴스를 찾을 수 없습니다.enrollmentRid
OrganizationNotFoundNOT_FOUND404지정한 조직을 찾을 수 없습니다.organizationRid

요청 예제

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/organizations?preview=true" \
	-d '{"enrollmentRid":"ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6","name":"Example Organization","host":"example.palantirfoundry.com","administrators":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'

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 = {
    "enrollmentRid": "ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6",
    "name": "Example Organization",
    "host": "example.palantirfoundry.com",
    "administrators": [
        "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
    ]
}

response = requests.post('https://{}/api/v2/admin/organizations?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateOrganizationExample.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 CreateOrganizationExample {
    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/organizations?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"enrollmentRid\":\"ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6\",\"name\":\"Example Organization\",\"host\":\"example.palantirfoundry.com\",\"administrators\":[\"f05f8da4-b84c-4fca-9c77-8af0b13d11de\"]}", 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/organizations?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"enrollmentRid":"ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6","name":"Example Organization","host":"example.palantirfoundry.com","administrators":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'
}).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?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"enrollmentRid`":`"ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6`",`"name`":`"Example Organization`",`"host`":`"example.palantirfoundry.com`",`"administrators`":[`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"]}"

$response.content