Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

그룹 구성원 조회(List Group Members) (V2)

그룹의 사용자 및 하위 그룹 구성원을 조회합니다. transitive=false가 기본값이며, true는 중첩된 그룹의 구성원도 재귀적으로 포함합니다.

임시 구성원의 만료 시각을 보려면 includeExpirations=true를 지정합니다. 기본값은 false입니다. 재귀 조회와 만료 시각 포함을 동시에 켤 수 없으므로, transitive=true 요청에서는 includeExpirations를 생략합니다.

페이지의 실제 항목 수는 요청한 크기와 다를 수 있습니다. 결과가 더 있으면 nextPageToken이 반환되며 다음 요청의 pageToken으로 사용합니다. 다음 토큰이 없으면 마지막 페이지입니다.

HTTP 요청

GET /api/v2/admin/groups/{groupId}/groupMembers

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

경로 매개변수

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

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
transitiveboolean선택기본값은 false입니다. 대상 그룹에 A가 속하고 A에 사용자 B가 속하면 false는 A만, true는 A와 B를 반환합니다. 모든 중첩 단계를 재귀적으로 해석하며, true일 때 includeExpirations=true를 함께 사용할 수 없습니다.
includeExpirationsboolean선택기본값은 false입니다. true이면 임시 구성원의 만료 시각을 포함합니다. transitive=true와 함께 켤 수 없습니다.
pageSizeinteger선택요청할 페이지 크기입니다.
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.

요청 본문

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

응답

응답 형식은 ListGroupMembersResponse입니다.

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

data의 구조

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

이름자료형필수 여부의미와 조건예시 값
principalTypeenum필수허용값: USER, GROUP.USER
principalIdstring필수Foundry 그룹 또는 사용자의 ID입니다.f05f8da4-b84c-4fca-9c77-8af0b13d11de
expirationstring (date-time)선택해당 구성원의 그룹 소속이 만료되는 시각입니다. 목록 조회에서 includeExpirations=true를 지정하지 않으면 이 필드는 항상 비어 있습니다.2026-01-30T23:59:59.000Z

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

{
  "data": [
    {
      "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
      "expiration": "2026-01-30T23:59:59.000Z",
      "principalType": "USER"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidPageSizeINVALID_ARGUMENT400페이지 크기가 0 또는 음수입니다. 0보다 커야 합니다.pageSize
ExpirationForTransitiveGroupMembersNotSupportedINVALID_ARGUMENT400transitive=true일 때 includeExpirations를 전달할 수 없습니다.
ListGroupMembersPermissionDeniedPERMISSION_DENIED403토큰에 해당 그룹의 구성원을 조회할 권한이 없습니다.groupId
GroupNotFoundNOT_FOUND404지정한 그룹을 찾을 수 없습니다.groupId

요청 예제

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

예제는 만료 시각을 함께 조회하므로 includeExpirations=true를 지정합니다. transitive는 생략해 기본값 false를 사용합니다. 응답 시각은 가상 소속 관계의 예시입니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers?includeExpirations=true"

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/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers?includeExpirations=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListGroupMembersExample.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 ListGroupMembersExample {
    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/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers?includeExpirations=true");
            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/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers?includeExpirations=true`, {
    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/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers?includeExpirations=true" `
	-Headers $headers

$response.content