사용자 보안 표지 조회(Get Markings User) (V2)
지정한 사용자가 현재 구성원으로 속한 보안 표지를 조회합니다. 반환된 view에는 게스트로 속한 조직의 조직 보안 표지도 포함됩니다. 보안 표지 접근 목록을 전체 리소스 권한 목록으로 해석하지 않습니다.
HTTP 요청
GET /api/v2/admin/users/{userId}/getMarkings
작업 식별자는 v2.getMarkingsUser입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
userId | string | 필수 | Foundry 사용자 ID입니다. | dd05feb8-662a-445d-8f4c-ce92d46bedeb |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 GetUserMarkingsResponse입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
view | list<MarkingId> | 선택 | 사용자가 접근할 수 있는 보안 표지 목록입니다. 해당 표지가 보호하는 리소스의 보안 표지 접근 조건에 사용하며, 사용자가 게스트로 속한 조직의 조직 보안 표지도 포함합니다. |
view의 구조
배열 항목은 MarkingId이며 자료형은 string입니다.
보안 표지의 ID입니다.
가상 사용자를 대상으로 한 응답 예시입니다.
{
"view": [
"18212f9a-0e63-4b79-96a0-aae04df23336"
]
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
UserDeleted | INVALID_ARGUMENT | 400 | 사용자가 삭제된 상태입니다. | principalId |
GetMarkingsUserPermissionDenied | PERMISSION_DENIED | 403 | 사용자 보안 표지 조회 권한이 거부되었습니다. | userId |
UserNotFound | NOT_FOUND | 404 | 지정한 사용자를 찾을 수 없습니다. | userId |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/admin/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb/getMarkings"
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/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb/getMarkings'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetMarkingsUserExample.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 GetMarkingsUserExample {
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/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb/getMarkings");
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/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb/getMarkings`, {
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/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb/getMarkings" `
-Headers $headers
$response.content