보안 표지 역할 추가(Add Marking Role Assignments) (V2)
보안 표지에 사용자 또는 그룹의 역할을 추가합니다. 각 항목은 대상 principalId와 부여할 role로 구성합니다.
조직 표지에는 이 API로 USE와 DECLASSIFY만 관리할 수 있습니다. 조직의 ADMINISTER 역할은 Organization Role Assignment API를 사용해야 합니다.
HTTP 요청
POST /api/v2/admin/markings/{markingId}/roleAssignments/add
작업 식별자는 v2.addMarkingRoleAssignments입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
markingId | string | 필수 | 보안 표지의 ID입니다. | 18212f9a-0e63-4b79-96a0-aae04df23336 |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
본문 형식은 AddMarkingRoleAssignmentsRequest이며 필수입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
roleAssignments | list<MarkingRoleUpdate> | 선택 |
roleAssignments의 구조
배열 항목은 MarkingRoleUpdate이며 자료형은 object입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
role | enum | 필수 | ADMINISTER는 구성원 추가 및 제거, 역할 할당 변경과 표지 메타데이터 변경을 허용합니다. DECLASSIFY는 리소스에서 표지를 제거하고 변환 중 표지 전파를 중지할 수 있게 합니다. USE는 리소스에 표지를 적용할 수 있게 합니다. 허용값: ADMINISTER, DECLASSIFY, USE. | ADMINISTER |
principalId | string | 필수 | Foundry 그룹 또는 사용자의 ID입니다. | f05f8da4-b84c-4fca-9c77-8af0b13d11de |
다음 본문의 식별자와 값은 가상 예시입니다.
{
"roleAssignments": [
{
"role": "ADMINISTER",
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
}
]
}
응답
성공 응답에 반환할 본문 모델이 없습니다.
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
PrincipalNotFound | NOT_FOUND | 404 | 지정한 PrincipalId의 사용자 또는 그룹을 찾을 수 없습니다. | principalId |
GetMarkingPermissionDenied | PERMISSION_DENIED | 403 | 토큰에 해당 보안 표지를 조회할 권한이 없습니다. | markingId |
OrganizationMarkingAdministerRoleNotSupported | INVALID_ARGUMENT | 400 | 조직 표지의 ADMINISTER는 보안 표지 역할 API로 관리할 수 없습니다. Organization Role Assignment API로 조직 관리자 역할을 관리합니다. | markingId, organizationRid |
AddMarkingRoleAssignmentsPermissionDenied | PERMISSION_DENIED | 403 | 보안 표지 역할 추가 권한이 거부되었습니다. | markingId |
MarkingNotFound | NOT_FOUND | 404 | 지정한 보안 표지를 찾을 수 없습니다. | markingId |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
예제의 ADMINISTER 부여는 조직 표지가 아닌 일반 보안 표지를 대상으로 합니다. 실제 대상 표지와 주체 ID를 준비합니다.
cURL
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/admin/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments/add" \
-d '{"roleAssignments":[{"role":"ADMINISTER","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": [
{
"role": "ADMINISTER",
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
}
]
}
response = requests.post('https://{}/api/v2/admin/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments/add'.format(HOSTNAME), headers=headers, json=request_body)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddMarkingRoleAssignmentsExample.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 AddMarkingRoleAssignmentsExample {
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/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments/add");
request.addHeader("content-type", "application/json");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
request.setEntity(new StringEntity("{\"roleAssignments\":[{\"role\":\"ADMINISTER\",\"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/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments/add`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${TOKEN}`,
},
body: '{"roleAssignments":[{"role":"ADMINISTER","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/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments/add" `
-Method Post `
-Headers $headers `
-ContentType application/json `
-Body "{`"roleAssignments`":[{`"role`":`"ADMINISTER`",`"principalId`":`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"}]}"
$response.content