Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

프로젝트 조직 요구조건 추가(Add Organizations) (V2)

프로젝트에 조직 RID 목록을 추가하여 접근 요구조건을 변경합니다. 적용할 조직은 상위 공간에도 적용되어 있어야 하며, 조직이 있는 공간 아래에 조직이 없는 프로젝트를 만드는 구성은 허용하지 않습니다.

일반 보안 표지 추가 API 대신 이 프로젝트 조직 엔드포인트를 사용합니다. 사용자의 소속 조직을 변경하는 작업과 구분합니다.

HTTP 요청

POST /api/v2/filesystem/projects/{projectRid}/addOrganizations

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
projectRidstring필수프로젝트의 고유 식별자(RID)입니다.ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8

쿼리 매개변수

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

요청 본문

본문 형식은 AddOrganizationsRequest이며 필수입니다.

이름자료형필수 여부의미와 조건예시 값
organizationRidslist<OrganizationRid>선택

organizationRids의 구조

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

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

{
  "organizationRids": [
    "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
  ]
}

응답

성공 응답에 반환할 본문 모델이 없습니다.

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
OrganizationsNotFoundNOT_FOUND404지정한 조직 RID 중 하나 이상을 찾을 수 없습니다.organizationRids
InvalidOrganizationHierarchyINVALID_ARGUMENT400프로젝트의 조직은 상위 공간에도 적용되어 있어야 합니다. 조직이 적용된 공간 안에서 프로젝트의 조직이 하나도 없게 되거나, 상위 공간에 없는 조직을 프로젝트에 적용하면 생성 시와 이후 변경 시 모두 이 오류가 발생합니다.organizationRids
AddOrganizationsPermissionDeniedPERMISSION_DENIED403프로젝트에 조직을 추가할 수 없습니다.projectRid
ProjectNotFoundNOT_FOUND404지정한 프로젝트를 찾을 수 없습니다.projectRid

요청 예제

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/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/addOrganizations" \
	-d '{"organizationRids":["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 = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "organizationRids": [
        "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
    ]
}

response = requests.post('https://{}/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/addOrganizations'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddOrganizationsExample.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 AddOrganizationsExample {
    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/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/addOrganizations");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"organizationRids\":[\"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa\"]}", 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/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/addOrganizations`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"organizationRids":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/addOrganizations" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"organizationRids`":[`"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa`"]}"

$response.content