그룹 구성원 제거(Remove Group Members) (V2)

principalIds에 지정한 사용자 또는 그룹을 대상 그룹의 구성원 목록에서 제거합니다. 변경 대상은 그룹의 소속 관계입니다.

HTTP 요청

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

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

경로 매개변수

쿼리 매개변수

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

요청 본문

본문은 필수 RemoveGroupMembersRequest 객체입니다. 제거할 사용자 또는 그룹의 ID를 principalIds에 지정합니다.

principalIds의 구조

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

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

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

{
  "principalIds": [
    "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
  ]
}

응답

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

개별 오류

요청 예제

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/remove" \
	-d '{"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 = {
    "principalIds": [
        "f05f8da4-b84c-4fca-9c77-8af0b13d11de"
    ]
}

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 RemoveGroupMembersExample.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 RemoveGroupMembersExample {
    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/remove");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"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/remove`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"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/remove" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"principalIds`":[`"f05f8da4-b84c-4fca-9c77-8af0b13d11de`"]}"

$response.content