Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

리소스 접근 요구조건 조회(Get Access Requirements) (V2)

리소스를 보기 위해 충족해야 하는 조직과 보안 표지 요구조건을 조회합니다. 리소스에 직접 적용한 조건과 상속한 조건을 모두 포함합니다. 직접 적용된 표지 ID만 필요하면 List Markings Of Resource를 사용합니다.

이 응답은 조직과 표지의 자격 조건입니다. 실제 리소스에 대한 역할 권한과 구분하며, 이 조회로 역할이나 구성원 자격을 부여하지 않습니다.

HTTP 요청

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

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

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

응답

응답 형식은 AccessRequirements입니다.

리소스의 접근 요구조건은 조직과 보안 표지로 구성됩니다. 조직은 OR 조건이고 보안 표지는 AND 조건입니다.

이름자료형필수 여부의미와 조건예시 값
organizationslist<Organization>선택
markingslist<Marking>선택

organizations의 구조

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

조직은 사용자와 리소스 사이의 접근 경계를 위해 프로젝트에 적용하는 요구조건입니다. 개인 사용자의 기본 조직은 하나이며 여러 조직에 게스트로 참여할 수 있습니다. 프로젝트에 적용된 조직 중 적어도 하나의 구성원 또는 게스트 구성원이어야 조직 요구조건을 충족합니다. 조직 요구조건은 파일 계층과 직접 의존성을 통해 상속됩니다.

이름자료형필수 여부의미와 조건예시 값
markingIdstring필수보안 표지의 ID입니다.b8d7cf8a-5877-4f39-a3e4-2fd89ce164db
organizationRidstring필수ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa
isDirectlyAppliedboolean필수리소스에 직접 적용한 표지인지 나타냅니다. 상위 리소스에 적용되어 현재 리소스가 상속한 경우에는 false입니다.

markings의 구조

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

파일, 폴더와 프로젝트에 추가 접근 조건을 적용하는 보안 표지입니다. 조건을 충족하는 사용자의 조회와 작업을 허용하며, 리소스에 적용된 모든 보안 표지의 구성원 조건을 충족해야 합니다.

이름자료형필수 여부의미와 조건예시 값
markingIdstring필수보안 표지의 ID입니다.18212f9a-0e63-4b79-96a0-aae04df23336
isDirectlyAppliedboolean필수리소스에 직접 적용한 표지인지 나타냅니다. 상위 리소스에 적용되어 현재 리소스가 상속한 경우에는 false입니다.

가상 조직 요구조건은 상속하고 보안 표지는 직접 적용한 리소스의 응답 예시입니다.

{
  "markings": [
    {
      "markingId": "18212f9a-0e63-4b79-96a0-aae04df23336",
      "isDirectlyApplied": true
    }
  ],
  "organizations": [
    {
      "organizationRid": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
      "markingId": "b8d7cf8a-5877-4f39-a3e4-2fd89ce164db",
      "isDirectlyApplied": false
    }
  ]
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
GetAccessRequirementsPermissionDeniedPERMISSION_DENIED403리소스의 접근 요구조건을 조회할 수 없습니다.resourceRid
ResourceNotFoundNOT_FOUND404지정한 리소스를 찾을 수 없습니다.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/getAccessRequirements"

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/getAccessRequirements'.format(HOSTNAME), headers=headers)
print(response)

Java

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

$response.content