Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

사용자의 그룹 소속 조회(List Group Memberships) (V2)

지정한 사용자가 속한 그룹을 페이지 단위로 조회합니다. transitive의 기본값은 false이며 직접 소속만 반환합니다. true로 지정하면 상위 그룹의 중첩 관계를 재귀적으로 따라갑니다.

사용자가 A에 속하고 A가 B에 속하면 기본 조회에는 A만, 재귀 조회에는 A와 B가 포함됩니다. 실제 페이지 크기는 요청보다 작거나 클 수 있습니다. 결과가 더 있으면 nextPageToken이 채워지며, 다음 요청의 pageToken에 전달합니다. 다음 토큰이 없으면 마지막 페이지입니다.

HTTP 요청

GET /api/v2/admin/users/{userId}/groupMemberships

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
userIdstring필수Foundry 사용자 ID입니다.dd05feb8-662a-445d-8f4c-ce92d46bedeb

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
transitiveboolean선택기본값은 false입니다. 사용자가 A에 속하고 A가 B에 속하면 false는 A만, true는 A와 B를 반환합니다. true는 모든 중첩 단계를 재귀적으로 해석합니다.
pageSizeinteger선택요청할 페이지 크기입니다.
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.

요청 본문

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

응답

응답 형식은 ListGroupMembershipsResponse입니다.

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

data의 구조

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

이름자료형필수 여부의미와 조건예시 값
groupIdstring필수Foundry 그룹 ID입니다.0d1fe74e-2b70-4a93-9b1a-80070637788b

가상 소속 관계의 응답 예시입니다.

{
  "data": [
    {
      "groupId": "0d1fe74e-2b70-4a93-9b1a-80070637788b"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidPageSizeINVALID_ARGUMENT400페이지 크기가 0 또는 음수입니다. 0보다 커야 합니다.pageSize
UserDeletedINVALID_ARGUMENT400사용자가 삭제된 상태입니다.principalId
UserNotFoundNOT_FOUND404지정한 사용자를 찾을 수 없습니다.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/groupMemberships"

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

Java

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

$response.content