Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

CBAC 표지 제약 조회(Get Cbac Marking Restrictions) (V2)

선택한 보안 표지 집합의 금지, 함의 및 필수 조건을 조회합니다. 분류 구성 자체의 유효성인 isValid와 현재 사용자의 표지 자격인 userSatisfiesMarkings는 서로 다른 판단입니다.

requiredMarkings의 각 내부 목록에서는 표지를 최소 하나 선택해야 하며 모든 내부 목록의 요구를 충족해야 합니다. disallowedMarkings에는 입력에 없는 양립 불가 표지도 포함할 수 있습니다. 이 응답으로 선택 대화상자가 선택의 유효성과 충분성을 판단할 수 있습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

GET /api/v2/admin/cbacMarkingRestrictions

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

경로 매개변수

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

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
markingIdslist<MarkingId>선택제약을 조회할 보안 표지 ID 목록입니다.["18212f9a-0e63-4b79-96a0-aae04df23336"]
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

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

응답

응답 형식은 CbacMarkingRestrictions입니다. 아래 비유효 선택 예시에서는 사용자가 표지 조건을 충족하더라도 입력 ID가 금지 목록에 들어 있으므로 isValid=false입니다.

이름자료형필수 여부의미와 조건예시 값
disallowedMarkingslist<MarkingId>선택입력 표지와 함께 선택할 수 없는 표지입니다. 입력 집합 안에 있는 표지에 한정하지 않고 양립할 수 없는 표지 전체를 포함합니다.
impliedMarkingslist<MarkingId>선택입력 표지 중 어느 하나의 구성원인 사용자가 CBAC 규칙에 따라 함께 자격을 갖는 표지입니다.
requiredMarkingslist<array>선택입력 표지와 함께 있어야 하는 표지의 목록들입니다. 각 내부 목록은 입력 표지 하나의 요구 조건이며, 모든 내부 목록에서 최소 하나씩 입력 markingIds에 포함해야 유효한 분류가 됩니다.
userSatisfiesMarkingsboolean필수현재 사용자가 입력 표지의 조건을 충족하면 true입니다. 결합형 표지는 모두 구성원이어야 하고, 선택형 표지는 범주별로 묶어 각 범주의 표지 중 하나 이상을 충족해야 합니다.true
isValidboolean필수입력에 금지된 표지가 없고 모든 필수 표지 제약을 충족해 유효한 분류를 이루면 true입니다.false

이 요청은 표지 자격과 선택 집합의 제약을 조회하며 사용자나 그룹의 소속 관계를 변경하지 않습니다.

disallowedMarkings의 구조

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

보안 표지의 ID입니다.

impliedMarkings의 구조

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

보안 표지의 ID입니다.

requiredMarkings의 구조

배열 항목은 array이며 자료형은 list<MarkingId>입니다.

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

보안 표지의 ID입니다.

가상 비유효 보안 분류 선택의 응답 예시입니다.

{
  "disallowedMarkings": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ],
  "requiredMarkings": [
    [
      "18212f9a-0e63-4b79-96a0-aae04df23336"
    ]
  ],
  "userSatisfiesMarkings": true,
  "isValid": false,
  "impliedMarkings": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ]
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
GetCbacMarkingRestrictionInfoPermissionDeniedPERMISSION_DENIED403토큰에 해당 표지의 CBAC 제약을 조회할 권한이 없습니다.markingIds
CbacUnavailableINVALID_ARGUMENT400CBAC을 사용할 수 없습니다.
CbacMarkingRestrictionsNotFoundNOT_FOUND404지정한 CBAC 표지 제약을 찾을 수 없습니다.

요청 예제

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

예제는 가상 ID 18212f9a-0e63-4b79-96a0-aae04df23336을 선택한 경우입니다. 실제 요청에는 현재 CBAC 구성의 표지 ID를 사용합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/cbacMarkingRestrictions?markingIds=18212f9a-0e63-4b79-96a0-aae04df23336&preview=true"

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/cbacMarkingRestrictions?markingIds=18212f9a-0e63-4b79-96a0-aae04df23336&preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetCbacMarkingRestrictionsExample.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 GetCbacMarkingRestrictionsExample {
    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/cbacMarkingRestrictions?markingIds=18212f9a-0e63-4b79-96a0-aae04df23336&preview=true");
            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/cbacMarkingRestrictions?markingIds=18212f9a-0e63-4b79-96a0-aae04df23336&preview=true`, {
    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/cbacMarkingRestrictions?markingIds=18212f9a-0e63-4b79-96a0-aae04df23336&preview=true" `
	-Headers $headers

$response.content