조직에 할당 가능한 역할 조회(List Available Roles Organization) (V2)

지정한 조직에서 주체에게 할당할 수 있는 역할을 조회합니다. 역할을 추가할 때는 이 응답의 실제 id와 권한 정의를 사용합니다.

일반 리소스의 Owner, Editor, Viewer, Discoverer라는 기본 역할 설명을 조직 역할 ID 목록으로 대체하지 않습니다. 응답의 type은 ORGANIZATION이며 name, description, operations로 역할의 의미를 확인합니다. 기본 역할은 Palantir가 제공하고 관리자가 변경할 수 없습니다.

HTTP 요청

GET /api/v2/admin/organizations/{organizationRid}/listAvailableRoles

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

경로 매개변수

쿼리 매개변수

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

요청 본문

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

응답

응답 형식은 ListAvailableOrganizationRolesResponse입니다. 예시의 이름과 식별자는 특정 플랫폼의 실제 역할 카탈로그를 나타내지 않는 가상 값입니다.

data의 구조

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

특정 리소스 유형에 대해 사용자 또는 그룹 주체에 할당할 수 있는 권한 집합입니다.

operations의 구조

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

리소스에서 수행할 수 있는 작업이며 역할의 권한을 정의합니다. 일반적으로 service:action 형식으로, service는 리소스 유형과 관련된 서비스이고 action은 수행할 작업입니다.

가상 조직 역할의 응답 예시입니다.

{
  "data": [
    {
      "roleSetId": "3181190f-f6b8-4649-90ec-64fa2d847204",
      "operations": [
        "compass:read-resource"
      ],
      "id": "8bf49052-dc37-4528-8bf0-b551cfb71268",
      "type": "ORGANIZATION",
      "name": "Example organization role",
      "description": "Illustrative organization-scoped resource role",
      "isDefault": false
    }
  ]
}

개별 오류

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/listAvailableRoles"

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/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/listAvailableRoles'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListAvailableRolesOrganizationExample.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 ListAvailableRolesOrganizationExample {
    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/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/listAvailableRoles");
            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/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/listAvailableRoles`, {
    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/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/listAvailableRoles" `
	-Headers $headers

$response.content