보안 표지 생성(Create Marking) (V2)

지정한 범주에 보안 표지를 만들고 초기 구성원 및 역할을 설정합니다. 이름은 비어 있을 수 없고 같은 범주에서 중복될 수 없습니다.

초기 역할에는 ADMINISTER가 최소 하나 필요합니다. 자신이나 자신이 속한 그룹을 관리자에 포함하지 않으면 새 표지를 직접 관리할 수 없습니다. 초기 구성원과 관리 역할은 별도로 지정합니다.

HTTP 요청

POST /api/v2/admin/markings

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

경로 매개변수

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

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

본문은 필수 CreateMarkingRequest 객체입니다. name과 categoryId는 필수이고 설명, 초기 구성원 및 역할 목록을 함께 설정합니다. initialRoleAssignments의 형식상 선택 여부와 별개로 관리자 최소 한 명 조건을 충족해야 합니다.

initialRoleAssignments의 구조

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

initialMembers의 구조

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

Foundry 그룹 또는 사용자의 ID입니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "initialMembers": [
    "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
  ],
  "name": "PII",
  "description": "Contains personally identifiable information about our customers",
  "categoryId": "0950264e-01c8-4e83-81a9-1a6b7f77621a",
  "initialRoleAssignments": [
    {
      "role": "ADMINISTER",
      "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
    }
  ]
}

응답

응답 형식은 Marking입니다.

생성한 보안 표지입니다.

가상 일반 보안 표지의 응답 예시입니다.

{
  "deleted": false,
  "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "name": "PII",
  "description": "Contains personally identifiable information about our customers",
  "createdTime": "2003-05-06T12:34:56.789Z",
  "id": "18212f9a-0e63-4b79-96a0-aae04df23336",
  "categoryId": "0950264e-01c8-4e83-81a9-1a6b7f77621a"
}

개별 오류

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/markings" \
	-d '{"initialMembers":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"],"name":"PII","description":"Contains personally identifiable information about our customers","categoryId":"0950264e-01c8-4e83-81a9-1a6b7f77621a","initialRoleAssignments":[{"role":"ADMINISTER","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"}]}'

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "initialMembers": [
        "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
    ],
    "name": "PII",
    "description": "Contains personally identifiable information about our customers",
    "categoryId": "0950264e-01c8-4e83-81a9-1a6b7f77621a",
    "initialRoleAssignments": [
        {
            "role": "ADMINISTER",
            "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
        }
    ]
}

response = requests.post('https://{}/api/v2/admin/markings'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateMarkingExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class CreateMarkingExample {
    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()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/admin/markings");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"initialMembers\":[\"f05f8da4-b84c-4fca-9c77-8af0b13d11de\"],\"name\":\"PII\",\"description\":\"Contains personally identifiable information about our customers\",\"categoryId\":\"0950264e-01c8-4e83-81a9-1a6b7f77621a\",\"initialRoleAssignments\":[{\"role\":\"ADMINISTER\",\"principalId\":\"f05f8da4-b84c-4fca-9c77-8af0b13d11de\"}]}", ContentType.APPLICATION_JSON));
            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`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"initialMembers":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"],"name":"PII","description":"Contains personally identifiable information about our customers","categoryId":"0950264e-01c8-4e83-81a9-1a6b7f77621a","initialRoleAssignments":[{"role":"ADMINISTER","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"}]}'
}).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" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"initialMembers`":[`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"],`"name`":`"PII`",`"description`":`"Contains personally identifiable information about our customers`",`"categoryId`":`"0950264e-01c8-4e83-81a9-1a6b7f77621a`",`"initialRoleAssignments`":[{`"role`":`"ADMINISTER`",`"principalId`":`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"}]}"

$response.content