보안 표지 구성원 추가(Add Marking Members) (V2)
principalIds에 지정한 사용자 또는 그룹을 보안 표지의 구성원으로 추가합니다. 구성원 지정은 해당 표지의 접근 조건에 영향을 주며, 표지의 관리 및 적용 역할을 부여하는 작업과 구분합니다.
HTTP 요청
POST /api/v2/admin/markings/{markingId}/markingMembers/add
작업 식별자는 v2.addMarkingMembers입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-write 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
markingId | string | 필수 | 보안 표지의 ID입니다. | 18212f9a-0e63-4b79-96a0-aae04df23336 |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
본문 형식은 AddMarkingMembersRequest이며 필수입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
principalIds | list<PrincipalId> | 선택 |
principalIds의 구조
배열 항목은 PrincipalId이며 자료형은 string입니다.
Foundry 그룹 또는 사용자의 ID입니다.
다음 본문의 식별자와 값은 가상 예시입니다.
{
"principalIds": [
"f05f8da4-b84c-4fca-9c77-8af0b13d11de"
]
}
응답
성공 응답에 반환할 본문 모델이 없습니다.
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
PrincipalNotFound | NOT_FOUND | 404 | 지정한 PrincipalId의 사용자 또는 그룹을 찾을 수 없습니다. | principalId |
GetMarkingPermissionDenied | PERMISSION_DENIED | 403 | 토큰에 해당 보안 표지를 조회할 권한이 없습니다. | markingId |
AddMarkingMembersPermissionDenied | PERMISSION_DENIED | 403 | 보안 표지 구성원 추가 권한이 거부되었습니다. | markingId |
MarkingNotFound | NOT_FOUND | 404 | 지정한 보안 표지를 찾을 수 없습니다. | markingId |
요청 예제
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/markings/18212f9a-0e63-4b79-96a0-aae04df23336/markingMembers/add" \
-d '{"principalIds":["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 = {
"principalIds": [
"f05f8da4-b84c-4fca-9c77-8af0b13d11de"
]
}
response = requests.post('https://{}/api/v2/admin/markings/18212f9a-0e63-4b79-96a0-aae04df23336/markingMembers/add'.format(HOSTNAME), headers=headers, json=request_body)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddMarkingMembersExample.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 AddMarkingMembersExample {
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/markingMembers/add");
request.addHeader("content-type", "application/json");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
request.setEntity(new StringEntity("{\"principalIds\":[\"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/markingMembers/add`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${TOKEN}`,
},
body: '{"principalIds":["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/markingMembers/add" `
-Method Post `
-Headers $headers `
-ContentType application/json `
-Body "{`"principalIds`":[`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"]}"
$response.content