Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

그룹 소속 만료 정책 교체(Replace Group Membership Expiration Policy) (V2)

그룹의 소속 만료 정책을 교체합니다. 구성원을 추가할 때 적용할 상대 기간 한도와 절대 만료 시각 한도를 지정합니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

maximumDuration은 초 단위 long 정수입니다. 구성원 추가 시점부터 만료까지의 기간은 이 값 미만이어야 합니다. 만료 시각은 maximumValue보다 앞서야 하므로 상한과 같은 값은 조건을 충족하지 않습니다. 두 조건을 모두 설정하면 둘 다 충족해야 합니다.

HTTP 요청

PUT /api/v2/admin/groups/{groupId}/membershipExpirationPolicy

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

경로 매개변수

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

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

본문은 필수 ReplaceGroupMembershipExpirationPolicyRequest 객체입니다. 두 제약 필드는 각각 선택사항입니다.

이름자료형필수 여부의미와 조건예시 값
maximumDurationlong선택구성원을 추가한 시점부터 만료까지의 기간이 이 초 단위 정수 한도보다 짧아야 합니다.30
maximumValuestring (date-time)선택구성원을 추가할 때 지정하는 만료 시각은 이 값보다 앞서야 합니다.2026-01-31T00:00:00.000Z

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

{
  "maximumDuration": 30,
  "maximumValue": "2026-01-31T00:00:00.000Z"
}

응답

응답 형식은 GroupMembershipExpirationPolicy입니다.

교체한 그룹 소속 만료 정책입니다.

이름자료형필수 여부의미와 조건예시 값
maximumValuestring (date-time)선택구성원을 추가할 때 지정하는 만료 시각은 이 값보다 앞서야 합니다.2026-01-31T00:00:00.000Z
maximumDurationlong선택구성원을 추가한 시점부터 만료까지의 기간이 이 초 단위 정수 한도보다 짧아야 합니다.30

가상 만료 정책의 응답 예시입니다.

{
  "maximumDuration": 30,
  "maximumValue": "2026-01-31T00:00:00.000Z"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ReplaceGroupMembershipExpirationPolicyPermissionDeniedPERMISSION_DENIED403그룹 소속 만료 정책 교체 권한이 거부되었습니다.groupId
GroupNotFoundNOT_FOUND404지정한 그룹을 찾을 수 없습니다.groupId

요청 예제

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

예시의 30은 30초입니다. 날짜와 기간은 가상 정책 값이므로 실제 그룹에 적용하려는 제약으로 바꿉니다.

cURL

curl -X PUT \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/membershipExpirationPolicy?preview=true" \
	-d '{"maximumDuration":30,"maximumValue":"2026-01-31T00:00:00.000Z"}'

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 = {
    "maximumDuration": 30,
    "maximumValue": "2026-01-31T00:00:00.000Z"
}

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ReplaceGroupMembershipExpirationPolicyExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
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 ReplaceGroupMembershipExpirationPolicyExample {
    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()) {
            HttpPut request = new HttpPut("https://" + HOSTNAME + "/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/membershipExpirationPolicy?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"maximumDuration\":30,\"maximumValue\":\"2026-01-31T00:00:00.000Z\"}", 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/membershipExpirationPolicy?preview=true`, {
    method: 'PUT',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"maximumDuration":30,"maximumValue":"2026-01-31T00:00:00.000Z"}'
}).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/membershipExpirationPolicy?preview=true" `
	-Method Put `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"maximumDuration`":30,`"maximumValue`":`"2026-01-31T00:00:00.000Z`"}"

$response.content