보안 표지 범주 조회(Get Marking Category) (V2)
ID로 범주 메타데이터와 포함된 표지 ID 목록을 조회합니다. 사용자 생성 범주의 ID는 UUID지만 조직 표지의 범주 ID는 Organization입니다. 모든 범주 ID를 UUID로 제한하지 않습니다.
HTTP 요청
GET /api/v2/admin/markingCategories/{markingCategoryId}
작업 식별자는 v2.getMarkingCategory입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
markingCategoryId | string | 필수 | 보안 표지 범주 ID입니다. 사용자가 만든 범주는 UUID이며, 조직에 연결된 표지는 ID가 Organization인 범주에 속합니다. | 0950264e-01c8-4e83-81a9-1a6b7f77621a |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 MarkingCategory입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
id | string | 필수 | 보안 표지 범주 ID입니다. 사용자가 만든 범주는 UUID이며, 조직에 연결된 표지는 ID가 Organization인 범주에 속합니다. | 0950264e-01c8-4e83-81a9-1a6b7f77621a |
name | string | 필수 | Customer Data | |
description | string | 필수 | Markings related to data about our customers | |
categoryType | enum | 필수 | 허용값: CONJUNCTIVE, DISJUNCTIVE. | CONJUNCTIVE |
markingType | enum | 필수 | 허용값: MANDATORY, CBAC. | MANDATORY |
priority | long | 선택 | CBAC 범주에서만 사용하는 우선순위입니다. 숫자가 클수록 우선순위가 높습니다. | 10 |
markings | list<MarkingId> | 선택 | ||
deleted | boolean | 필수 | 범주가 삭제되었는지 나타냅니다. | false |
createdTime | string (date-time) | 필수 | 리소스 생성 시각입니다. | 2003-05-06T12:34:56.789Z |
createdBy | string | 선택 | 리소스를 생성한 Foundry 사용자입니다. | f05f8da4-b84c-4fca-9c77-8af0b13d11de |
markings의 구조
배열 항목은 MarkingId이며 자료형은 string입니다.
보안 표지의 ID입니다.
가상 보안 표지 범주의 응답 예시입니다.
{
"categoryType": "CONJUNCTIVE",
"deleted": false,
"markings": [
"18212f9a-0e63-4b79-96a0-aae04df23336"
],
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"name": "Customer Data",
"description": "Markings related to data about our customers",
"createdTime": "2003-05-06T12:34:56.789Z",
"id": "0950264e-01c8-4e83-81a9-1a6b7f77621a",
"markingType": "MANDATORY"
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
GetMarkingCategoryPermissionDenied | PERMISSION_DENIED | 403 | 토큰에 해당 보안 표지 범주를 조회할 권한이 없습니다. | markingCategoryId |
MarkingCategoryNotFound | NOT_FOUND | 404 | 지정한 보안 표지 범주를 찾을 수 없습니다. | markingCategoryId |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/admin/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a"
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"authorization": "Bearer {}".format(TOKEN)
}
response = requests.get('https://{}/api/v2/admin/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetMarkingCategoryExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
public class GetMarkingCategoryExample {
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()) {
HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/admin/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
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/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${TOKEN}`,
}
}).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/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a" `
-Headers $headers
$response.content