리소스 역할 부여(Add Resource Roles) (V2)

지정한 리소스에 주체와 역할 ID의 조합을 추가합니다. roleId는 해당 공간의 프로젝트 역할 집합에서 유효한 ID여야 합니다. Owner나 Viewer 같은 표시 이름을 ID 대신 전달하지 않습니다.

쓰기 입력의 주체는 principalIdOnly와 principalId, 또는 everyone입니다. 조회 결과의 principalWithId를 그대로 복사하는 형태와 구분합니다. everyone은 플랫폼 사용자 전체에 영향을 주므로 대상 범위를 확인합니다.

HTTP 요청

POST /api/v2/filesystem/resources/{resourceRid}/roles/add

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

경로 매개변수

쿼리 매개변수

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

요청 본문

본문 형식은 AddResourceRolesRequest이며 필수입니다.

roles의 구조

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

주체 유형을 따로 지정하지 않는 역할 추가 및 제거용 부여 정보입니다.

resourceRolePrincipal의 구조

분기 principalIdOnly

주체 유형 없이 ID만 지정합니다.

분기 everyone

플랫폼의 모든 사용자를 나타내는 주체입니다.

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

{
  "roles": [
    {
      "resourceRolePrincipal": {
        "type": "principalIdOnly",
        "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
      },
      "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"
    }
  ]
}

응답

성공 응답에 반환할 본문 모델이 없습니다.

개별 오류

요청 예제

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

예시 주체 ID와 역할 ID는 실제 승인한 대상과 역할로 바꿉니다. 이 요청은 해당 리소스의 역할 부여를 변경합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles/add" \
	-d '{"roles":[{"resourceRolePrincipal":{"type":"principalIdOnly","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"},"roleId":"8bf49052-dc37-4528-8bf0-b551cfb71268"}]}'

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 = {
    "roles": [
        {
            "resourceRolePrincipal": {
                "type": "principalIdOnly",
                "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
            },
            "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"
        }
    ]
}

response = requests.post('https://{}/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles/add'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddResourceRolesExample.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 AddResourceRolesExample {
    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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles/add");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"roles\":[{\"resourceRolePrincipal\":{\"type\":\"principalIdOnly\",\"principalId\":\"f05f8da4-b84c-4fca-9c77-8af0b13d11de\"},\"roleId\":\"8bf49052-dc37-4528-8bf0-b551cfb71268\"}]}", 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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles/add`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"roles":[{"resourceRolePrincipal":{"type":"principalIdOnly","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"},"roleId":"8bf49052-dc37-4528-8bf0-b551cfb71268"}]}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles/add" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"roles`":[{`"resourceRolePrincipal`":{`"type`":`"principalIdOnly`",`"principalId`":`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"},`"roleId`":`"8bf49052-dc37-4528-8bf0-b551cfb71268`"}]}"

$response.content