리소스 역할 목록(List Resource Roles) (V2)

리소스에 부여된 역할을 조회합니다. includeInherited로 상속된 역할의 포함 여부를 정합니다. 포함해야 하는 경우 true를 명시하고, 첫 페이지에서는 pageToken을 생략합니다.

반환하는 ResourceRole의 주체는 ID와 사용자 또는 그룹 유형을 포함하는 principalWithId, 또는 플랫폼 사용자 전체를 뜻하는 everyone입니다. 역할을 변경할 때의 입력 형태와 다릅니다.

HTTP 요청

GET /api/v2/filesystem/resources/{resourceRid}/roles

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

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`resourceRid`	`string`	필수	리소스의 고유 식별자(RID)입니다.	`ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건
`includeInherited`	`boolean`	선택	리소스에서 상속된 역할을 함께 반환할지 정합니다.
`pageSize`	`integer`	선택	요청할 페이지 크기입니다.
`pageToken`	`string`	선택	페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 `nextPageToken`을 `pageToken`으로 전달합니다.

요청 본문

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

응답

응답 형식은 ListResourceRolesResponse입니다.

목록 항목에는 resourceRolePrincipal과 roleId가 있습니다. 사용자 또는 그룹에는 principalId와 principalType이 함께 반환되며, principalType은 USER 또는 GROUP입니다.

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

`data`의 구조

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

이름	자료형	필수 여부	의미와 조건	예시 값
`resourceRolePrincipal`	`union<principalWithId, everyone>`	필수		응답 예시 참조
`roleId`	`string`	필수	부여된 역할의 고유 ID입니다. 역할은 리소스 접근 수준을 정하는 권한 집합이며, 기본 제공 역할에는 Owner, Editor, Viewer, Discoverer가 있습니다. ID와 표시 이름을 구분합니다.	`8bf49052-dc37-4528-8bf0-b551cfb71268`

`resourceRolePrincipal`의 구조

분기 `principalWithId`

ID가 있는 사용자 또는 그룹 주체입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	분기를 구분하는 `type` 값입니다. 허용값: `principalWithId`.	`principalWithId`
`principalId`	`string`	필수	Foundry 그룹 또는 사용자의 ID입니다.	`f05f8da4-b84c-4fca-9c77-8af0b13d11de`
`principalType`	`enum`	필수	허용값: `USER`, `GROUP`.	`GROUP`

분기 `everyone`

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

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	분기를 구분하는 `type` 값입니다. 허용값: `everyone`.	`everyone`

가상 그룹에 부여한 리소스 역할의 응답 예시입니다.

{
  "data": [
    {
      "resourceRolePrincipal": {
        "type": "principalWithId",
        "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
        "principalType": "GROUP"
      },
      "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름	오류 코드	HTTP	의미와 조건	추가 매개변수
`ResourceNotFound`	`NOT_FOUND`	404	지정한 리소스를 찾을 수 없습니다.	`resourceRid`

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles"

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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListResourceRolesExample.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 ListResourceRolesExample {
    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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles");
            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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/roles`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).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" `
	-Headers $headers

$response.content

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설