그룹 인증 제공자 정보 교체(Replace Group Provider Info) (V2)

외부 인증 제공자의 그룹과 Foundry 그룹을 연결하는 식별 정보를 교체합니다. 외부 제공자가 정한 providerId를 사용하며, 같은 인증 영역에서 해당 ID를 가진 그룹은 최대 하나입니다.

보호된 인증 영역의 주체 정보는 교체할 수 없습니다.

HTTP 요청

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

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

경로 매개변수

쿼리 매개변수

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

요청 본문

본문 형식은 ReplaceGroupProviderInfoRequest이며 필수입니다.

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

{
  "providerId": "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
}

응답

응답 형식은 GroupProviderInfo입니다.

교체한 그룹 인증 제공자 정보입니다.

가상 그룹 인증 제공자 정보의 응답 예시입니다.

{
  "providerId": "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
}

개별 오류

요청 예제

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

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/providerInfo" \
	-d '{"providerId":"2838c8f3-d76a-4e99-acf1-1dee537e4c48"}'

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 = {
    "providerId": "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
}

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

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ReplaceGroupProviderInfoExample.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 ReplaceGroupProviderInfoExample {
    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/providerInfo");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"providerId\":\"2838c8f3-d76a-4e99-acf1-1dee537e4c48\"}", 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/providerInfo`, {
    method: 'PUT',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"providerId":"2838c8f3-d76a-4e99-acf1-1dee537e4c48"}'
}).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/providerInfo" `
	-Method Put `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"providerId`":`"2838c8f3-d76a-4e99-acf1-1dee537e4c48`"}"

$response.content