CBAC 배너 조회(Get Cbac Banner) (V2)

표지 ID 집합에 대한 보안 분류 배너 문자열과 색을 조회합니다. 표시 유형은 기본적으로 문단용 짧은 문자열인 PORTION_MARKING이며 문서 머리글에는 BANNER_LINE을 사용할 수 있습니다.

중복 ID와 현재 CBAC 구성이 인식하지 못하는 ID는 제외합니다. 응답의 markings를 확인해 요청한 표지가 실제 배너에 반영되었는지 구분합니다. 반환 순서는 정해져 있지 않습니다.

HTTP 요청

GET /api/v2/admin/cbacBanner

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

경로 매개변수

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

쿼리 매개변수

요청 본문

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

응답

응답 형식은 CbacBanner입니다. backgroundColors는 단색 배경에 사용할 목록이며 여러 색이 있어도 첫 번째 색을 사용합니다.

markings의 구조

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

보안 표지의 ID입니다.

backgroundColors의 구조

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

색의 16진수 값입니다.

가상 보안 분류 배너의 응답 예시입니다.

{
  "markings": [
    "MTS",
    "MNF"
  ],
  "backgroundColors": [
    "#0F4B8F"
  ],
  "classificationString": "MTS//MNF",
  "textColor": "#FFFFFF"
}

개별 오류

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/cbacBanner?displayType=PORTION_MARKING&markingIds=MTS%2CMNF"

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/cbacBanner?displayType=PORTION_MARKING&markingIds=MTS%2CMNF'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetCbacBannerExample.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 GetCbacBannerExample {
    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/cbacBanner?displayType=PORTION_MARKING&markingIds=MTS%2CMNF");
            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/cbacBanner?displayType=PORTION_MARKING&markingIds=MTS%2CMNF`, {
    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/cbacBanner?displayType=PORTION_MARKING&markingIds=MTS%2CMNF" `
	-Headers $headers

$response.content