Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

보안 표지 역할 조회(List Marking Role Assignments) (V2)

보안 표지에 역할을 할당받은 사용자와 그룹을 조회합니다. 구성원 조회와 달리 이 GET 요청의 OAuth 권한 범위는 api:admin-read입니다.

pageSize는 무시합니다. pageToken은 첫 요청에서 생략하고 이후 응답의 nextPageToken을 사용합니다.

HTTP 요청

GET /api/v2/admin/markings/{markingId}/roleAssignments

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
markingIdstring필수보안 표지의 ID입니다.18212f9a-0e63-4b79-96a0-aae04df23336

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
pageSizeinteger선택이 엔드포인트는 pageSize 값을 무시합니다.
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.

요청 본문

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

응답

응답 형식은 ListMarkingRoleAssignmentsResponse입니다.

이름자료형필수 여부의미와 조건예시 값
datalist<MarkingRoleAssignment>선택
nextPageTokenstring선택다음 페이지를 요청할 때 pageToken에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

data의 구조

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

이름자료형필수 여부의미와 조건예시 값
principalTypeenum필수허용값: USER, GROUP.USER
principalIdstring필수Foundry 그룹 또는 사용자의 ID입니다.f05f8da4-b84c-4fca-9c77-8af0b13d11de
roleenum필수ADMINISTER는 구성원 추가 및 제거, 역할 할당 변경과 표지 메타데이터 변경을 허용합니다. DECLASSIFY는 리소스에서 표지를 제거하고 변환 중 표지 전파를 중지할 수 있게 합니다. USE는 리소스에 표지를 적용할 수 있게 합니다. 허용값: ADMINISTER, DECLASSIFY, USE.ADMINISTER

가상 보안 표지 역할 할당의 응답 예시입니다.

{
  "data": [
    {
      "role": "ADMINISTER",
      "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "principalType": "USER"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ListMarkingRoleAssignmentsPermissionDeniedPERMISSION_DENIED403토큰에 이 보안 표지의 역할 할당 목록을 조회할 권한이 없습니다.markingId
MarkingNotFoundNOT_FOUND404지정한 보안 표지를 찾을 수 없습니다.markingId

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments"

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/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments'.format(HOSTNAME), headers=headers)
print(response)

Java

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

$response.content