보안 분류 문자열 파싱(Parse Classifications) (V2)
MTS//MNF와 같은 보안 분류 문자열을 구성 보안 표지 ID로 파싱합니다. POST를 사용하지만 권한 범위는 api:admin-read입니다.
입력은 1~1,000개 항목입니다. 중복 문자열도 입력 개수에는 포함하지만 실제로는 한 번만 파싱합니다. 파싱에 실패한 문자열은 parsed에 없으며 errors에 오류 메시지와 함께 반환됩니다. HTTP 요청의 성공 여부와 각 문자열의 파싱 결과를 구분합니다.
HTTP 요청
POST /api/v2/admin/markings/parseClassifications
작업 식별자는 v2.parseClassifications입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
지정할 경로 매개변수가 없습니다.
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
본문 형식은 ParseClassificationsRequest이며 필수입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
classificationStrings | list<string> | 선택 | 파싱할 보안 분류 문자열 목록입니다. 예: MTS//MNF. 요청에는 1~1,000개 항목이 있어야 합니다. 중복도 개수 한도에 포함하지만 같은 문자열은 한 번만 파싱합니다. 빈 목록은 MissingBatchRequest, 1,000개 초과는 BatchRequestSizeExceededLimit 오류입니다. | 본문 예시 참조 |
다음 본문의 식별자와 값은 가상 예시입니다.
{
"classificationStrings": [
"MTS//MNF",
"INVALID_MARKING"
]
}
응답
응답 형식은 ParseClassificationsResponse입니다. parsed와 errors를 함께 확인합니다. 예시의 MNF, MTS처럼 보안 표지 ID가 분류 식별자일 수 있으므로 UUID만 허용하는 검사를 추가하지 않습니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
parsed | map<string, array> | 선택 | 유효한 보안 분류 문자열을 구성 표지 ID 목록으로 연결하는 맵입니다. 파싱할 수 없는 문자열은 이 맵에서 빠지고 errors에 들어갑니다. | 응답 예시 참조 |
errors | map<string, string> | 선택 | 파싱할 수 없는 보안 분류 문자열과 사람이 읽을 수 있는 오류 메시지의 맵입니다. | 응답 예시 참조 |
parsed의 구조
맵의 키는 보안 분류 문자열이고 값은 MarkingId 목록입니다. MarkingId는 보안 표지 ID를 담은 문자열입니다.
가상 보안 분류 문자열의 응답 예시입니다.
{
"parsed": {
"MTS//MNF": [
"MNF",
"MTS"
]
},
"errors": {
"INVALID_MARKING": "Unknown marking: INVALID_MARKING"
}
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
ParseClassificationsPermissionDenied | PERMISSION_DENIED | 403 | 토큰에 지정한 보안 분류 문자열을 파싱할 권한이 없습니다. | classificationStrings |
CbacUnavailable | INVALID_ARGUMENT | 400 | CBAC을 사용할 수 없습니다. | |
MissingBatchRequest | INVALID_ARGUMENT | 400 | 배치 요청에 항목이 최소 하나 있어야 합니다. | |
BatchRequestSizeExceededLimit | INVALID_ARGUMENT | 400 | 제출한 배치가 크기 한도를 초과했습니다. | maximumBatchSize, providedBatchSize |
요청 예제
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/parseClassifications" \
-d '{"classificationStrings":["MTS//MNF","INVALID_MARKING"]}'
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 = {
"classificationStrings": [
"MTS//MNF",
"INVALID_MARKING"
]
}
response = requests.post('https://{}/api/v2/admin/markings/parseClassifications'.format(HOSTNAME), headers=headers, json=request_body)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ParseClassificationsExample.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 ParseClassificationsExample {
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/parseClassifications");
request.addHeader("content-type", "application/json");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
request.setEntity(new StringEntity("{\"classificationStrings\":[\"MTS//MNF\",\"INVALID_MARKING\"]}", 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/parseClassifications`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${TOKEN}`,
},
body: '{"classificationStrings":["MTS//MNF","INVALID_MARKING"]}'
}).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/parseClassifications" `
-Method Post `
-Headers $headers `
-ContentType application/json `
-Body "{`"classificationStrings`":[`"MTS//MNF`",`"INVALID_MARKING`"]}"
$response.content