보안 표지 범주 목록 조회(List Marking Categories) (V2)

보안 표지 범주 목록을 조회합니다. 최대 페이지 크기는 100입니다. includeDeleted를 생략하면 삭제된 범주도 포함하고, markingType을 생략하면 MANDATORY와 CBAC를 모두 대상으로 합니다.

첫 요청에서는 pageToken을 생략하고, 이후 요청에는 직전 응답의 nextPageToken을 전달합니다.

HTTP 요청

GET /api/v2/admin/markingCategories

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

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListMarkingCategoriesResponse입니다.

data의 구조

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

markings의 구조

배열 항목은 MarkingId이며 자료형은 string입니다.

보안 표지의 ID입니다.

가상 보안 표지 범주의 응답 예시입니다.

{
  "data": [
    {
      "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"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/markingCategories?markingType=MANDATORY"

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?markingType=MANDATORY'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListMarkingCategoriesExample.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 ListMarkingCategoriesExample {
    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?markingType=MANDATORY");
            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?markingType=MANDATORY`, {
    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?markingType=MANDATORY" `
	-Headers $headers

$response.content