플랫폼 인스턴스 역할 제거(Remove Enrollment Role Assignments) (V2)

지정한 플랫폼 인스턴스에서 주체의 역할 할당을 제거합니다. 한 요청에서 제거할 수 있는 역할 할당은 최대 100개입니다. 사용자 또는 그룹 리소스를 삭제하는 요청과 구분합니다.

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

HTTP 요청

POST /api/v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove

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

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`enrollmentRid`	`string`	필수		`ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6`

쿼리 매개변수

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

요청 본문

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

이름	자료형	필수 여부	의미와 조건	예시 값
`roleAssignments`	`list<RoleAssignmentUpdate>`	선택

`roleAssignments`의 구조

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

이름	자료형	필수 여부	의미와 조건	예시 값
`roleId`	`string`	필수	역할의 고유 ID입니다. 역할은 리소스 접근 수준을 정하는 권한 집합입니다. Foundry의 기본 리소스 역할에는 Owner, Editor, Viewer, Discoverer가 있으며, 이 요청에는 대상 리소스에 유효한 실제 역할 ID를 사용합니다.	`8bf49052-dc37-4528-8bf0-b551cfb71268`
`principalId`	`string`	필수	Foundry 그룹 또는 사용자의 ID입니다.	`f05f8da4-b84c-4fca-9c77-8af0b13d11de`

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

{
  "roleAssignments": [
    {
      "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268",
      "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
    }
  ]
}

응답

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

개별 오류

오류 이름	오류 코드	HTTP	의미와 조건	추가 매개변수
`PrincipalNotFound`	`NOT_FOUND`	404	지정한 PrincipalId의 사용자 또는 그룹을 찾을 수 없습니다.	`principalId`
`EnrollmentRoleNotFound`	`NOT_FOUND`	404	제공한 역할 ID 중 찾을 수 없는 값이 있습니다.
`RemoveEnrollmentRoleAssignmentsPermissionDenied`	`PERMISSION_DENIED`	403	플랫폼 인스턴스 역할 제거 권한이 거부되었습니다.	`enrollmentRid`
`EnrollmentNotFound`	`NOT_FOUND`	404	지정한 플랫폼 인스턴스를 찾을 수 없습니다.	`enrollmentRid`

요청 예제

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/enrollments/ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6/roleAssignments/remove?preview=true" \
	-d '{"roleAssignments":[{"roleId":"8bf49052-dc37-4528-8bf0-b551cfb71268","principalId":"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 = {
    "roleAssignments": [
        {
            "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268",
            "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
        }
    ]
}

response = requests.post('https://{}/api/v2/admin/enrollments/ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6/roleAssignments/remove?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

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

$response.content

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설