Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

리소스 역할 제거(Remove Resource Roles) (V2)

지정한 리소스에서 주체와 역할 ID의 조합을 제거합니다. 입력은 ResourceRoleIdentifier이며 ID가 있는 주체에는 principalIdOnly를 사용합니다.

제거할 리소스, 주체와 역할 ID를 함께 확인합니다. 변경 후 실제 접근 상태를 판단할 때는 역할 목록에서 상속된 역할도 확인하고, 조직 및 보안 표지 요구조건을 별도로 고려합니다.

HTTP 요청

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

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

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

이름자료형필수 여부의미와 조건예시 값
roleslist<ResourceRoleIdentifier>선택

roles의 구조

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

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

이름자료형필수 여부의미와 조건예시 값
resourceRolePrincipalunion<principalIdOnly, everyone>필수사용자나 그룹 유형을 따로 지정하지 않는 역할 변경용 주체입니다.본문 예시 참조
roleIdstring필수역할의 고유 ID입니다. 역할은 리소스 접근 수준을 정하는 권한 집합입니다. Foundry의 기본 리소스 역할에는 Owner, Editor, Viewer, Discoverer가 있으며, 이 요청에는 대상 리소스에 유효한 실제 역할 ID를 사용합니다.8bf49052-dc37-4528-8bf0-b551cfb71268
resourceRolePrincipal의 구조
분기 principalIdOnly

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

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: principalIdOnly.principalIdOnly
principalIdstring필수Foundry 그룹 또는 사용자의 ID입니다.f05f8da4-b84c-4fca-9c77-8af0b13d11de
분기 everyone

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

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

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

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

응답

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

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidRoleIdsINVALID_ARGUMENT400기본 역할이나 역할 부여에서 참조한 ID가 해당 공간의 프로젝트 역할 집합에 없습니다.requestedRoleIds
PrincipalNotFoundNOT_FOUND404지정한 PrincipalId의 사용자 또는 그룹을 찾을 수 없습니다.principalId
RemoveResourceRolesPermissionDeniedPERMISSION_DENIED403리소스에서 역할을 제거할 수 없습니다.resourceRid
ResourceNotFoundNOT_FOUND404지정한 리소스를 찾을 수 없습니다.resourceRid

요청 예제

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 RemoveResourceRolesExample.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 RemoveResourceRolesExample {
    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/remove");
            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/remove`, {
    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/remove" `
	-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