그룹 인증 제공자 정보 조회(Get Group Provider Info) (V2)
Foundry 그룹에 연결된 외부 인증 제공자의 그룹 식별자를 조회합니다. providerId는 해당 외부 시스템에서 그룹을 식별하는 값이며 제공자 설정 리소스 RID와 구분합니다.
HTTP 요청
GET /api/v2/admin/groups/{groupId}/providerInfo
작업 식별자는 v2.getGroupProviderInfo입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:admin-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
groupId | string | 필수 | Foundry 그룹 ID입니다. | 0d1fe74e-2b70-4a93-9b1a-80070637788b |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 GroupProviderInfo입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
providerId | string | 필수 | 외부 인증 제공자가 정한 그룹 식별자입니다. 같은 인증 영역에서 하나의 제공자 ID를 가진 그룹은 최대 하나입니다. | 2838c8f3-d76a-4e99-acf1-1dee537e4c48 |
가상 그룹 인증 제공자 정보의 응답 예시입니다.
{
"providerId": "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
GetGroupProviderInfoPermissionDenied | PERMISSION_DENIED | 403 | 토큰에 해당 그룹의 인증 제공자 정보를 조회할 권한이 없습니다. | groupId |
GroupProviderInfoNotFound | NOT_FOUND | 404 | 지정한 그룹 인증 제공자 정보를 찾을 수 없습니다. | groupId |
GroupNotFound | NOT_FOUND | 404 | 지정한 그룹을 찾을 수 없습니다. | groupId |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/providerInfo"
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/providerInfo'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetGroupProviderInfoExample.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 GetGroupProviderInfoExample {
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/providerInfo");
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/providerInfo`, {
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/providerInfo" `
-Headers $headers
$response.content