Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

그룹 구성원 추가(Add Group Members) (V2)

principalIds에 지정한 사용자 또는 그룹을 대상 그룹의 구성원으로 추가합니다. 만료 시각을 지정할 때는 그룹 소속 만료 정책의 조건을 충족해야 합니다.

가상 예제에서는 추가 시점을 2026-01-30T23:59:45.000Z, 만료 시각을 2026-01-30T23:59:59.000Z로 가정합니다. 14초 뒤에 만료되므로 30초 미만 조건과 2026-01-31T00:00:00.000Z보다 앞서야 한다는 조건을 충족합니다. 실제 요청에는 현재 대상 그룹 정책에 맞는 시각을 준비합니다.

HTTP 요청

POST /api/v2/admin/groups/{groupId}/groupMembers/add

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

경로 매개변수

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

쿼리 매개변수

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

요청 본문

본문은 필수 AddGroupMembersRequest 객체입니다. principalIds는 추가할 사용자 또는 그룹 ID 목록이고 expiration은 선택적인 만료 시각입니다. 선택 필드라도 설정된 그룹 정책의 조건은 충족해야 합니다.

이름자료형필수 여부의미와 조건예시 값
principalIdslist<PrincipalId>선택
expirationstring (date-time)선택2026-01-30T23:59:59.000Z

principalIds의 구조

배열 항목은 PrincipalId이며 자료형은 string입니다.

Foundry 그룹 또는 사용자의 ID입니다.

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

{
  "expiration": "2026-01-30T23:59:59.000Z",
  "principalIds": [
    "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
  ]
}

응답

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

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
PrincipalNotFoundNOT_FOUND404지정한 PrincipalId의 사용자 또는 그룹을 찾을 수 없습니다.principalId
InvalidGroupMembershipExpirationINVALID_ARGUMENT400지정한 만료 시각이 그룹의 소속 만료 조건을 충족하지 않습니다.groupId, earliestExpiration, maximumDuration, maximumValue
AddGroupMembersPermissionDeniedPERMISSION_DENIED403그룹 구성원 추가 권한이 거부되었습니다.groupId
GroupNotFoundNOT_FOUND404지정한 그룹을 찾을 수 없습니다.groupId

요청 예제

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/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers/add" \
	-d '{"expiration":"2026-01-30T23:59:59.000Z","principalIds":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'

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 = {
    "expiration": "2026-01-30T23:59:59.000Z",
    "principalIds": [
        "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
    ]
}

response = requests.post('https://{}/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers/add'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddGroupMembersExample.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 AddGroupMembersExample {
    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/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers/add");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"expiration\":\"2026-01-30T23:59:59.000Z\",\"principalIds\":[\"f05f8da4-b84c-4fca-9c77-8af0b13d11de\"]}", 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/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers/add`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"expiration":"2026-01-30T23:59:59.000Z","principalIds":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}'
}).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/add" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"expiration`":`"2026-01-30T23:59:59.000Z`",`"principalIds`":[`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"]}"

$response.content