연결된 모든 ID 제공자 반환
이 페이지의 내용
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
federationSettings 리소스를 사용하면 페더레이션 인증 구성에 대한 모든 ID 공급자 를 반환할 수 있습니다.
필수 역할
이 엔드포인트를 호출하려면 페더레이션 구성에서 하나 이상의 연결된 조직에 대한 Organization Owner 역할이 있어야 합니다.
Resource
GET /federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders/
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 페더레이션 인증 구성을 식별하는 고유한 24자리 16진수 문자열입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. |
|
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 옵션 |
| |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 |
|
protocol | 문자열 | 옵션 | 대상 IdP 의 프로토콜. 가능한 값은 다음과 같습니다.
이를 지정하지 않으면 이 엔드포인트는 |
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
results 배열의 각 문서에는 연결된 각 조직에 대한 페더레이션 인증 구성이 포함되어 있습니다.
이름 | 유형 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 문자열 | IdP 가 SAML 응답을 보내는 어설션 소비자 서비스 URL입니다. | |||||||||
| 배열 | 사용자가 이 IdP 에 로그인할 수 있는 구성된 도메인이 포함된 목록입니다. | |||||||||
| 배열 | 사용자가 이 IdP 에 로그인할 수 있는 조직이 포함된 목록입니다. | |||||||||
| 문자열 | SAML Assertion의의도된 대상에 대한 식별자입니다. | |||||||||
| 문자열 | IdP 를 식별하는 사람이 읽을 수 있는 레이블입니다. | |||||||||
| 문자열 | SAML Assertion 발급자의 식별자입니다. | |||||||||
| 문자열 | IdP 를 식별하는 고유한 20자리 16진수 문자열입니다. | |||||||||
| 배열 | ID 제공자의 PEM인코딩된 공개 키 인증서의 시작 날짜, 만료 날짜 등 파일 정보가 포함된 목록입니다.
| |||||||||
| 문자열 | AuthNRequest를 전송하는 데 사용되는 SAML 인증 요청 프로토콜 바인딩. Cloud Manager는 다음과 같은 바인딩 값을 지원합니다.
| |||||||||
| 문자열 | IdP 서명을 암호화하는 데 사용되는 알고리즘입니다. Cloud Manager는 다음과 같은 서명 알고리즘 값을 지원합니다.
| |||||||||
| 부울 | IdP 에 SSO 디버깅이 활성화되어 있는지 여부를 나타내는 플래그입니다. | |||||||||
| 문자열 | SAML AuthNRequest 수신자의 URL. | |||||||||
| 문자열 | ID 제공자가 활성 상태인지 여부를 나타내는 레이블입니다. 하나 이상의 도메인을 IdP 에 매핑할 때까지 IdP 는 Inactive 입니다. |
SAML 요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders"
SAML 응답 예시
{ "links": [ { "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "acsUrl" : "https://example.mongodb.com/sso/saml2/12345678901234567890", "associatedDomains" : [ ], "associatedOrgs" : [ ], "audienceUri" : "https://www.example.com/saml2/service-provider/abcdefghij1234567890", "displayName" : "Test", "issuerUri" : "urn:123456789000.us.provider.com", "oktaIdpId" : "1234567890abcdefghij", "pemFileInfo" : { "certificates" : [ { "notAfter" : "2035-09-29T15:03:55Z", "notBefore" : "2022-01-20T15:03:55Z" } ], "fileName" : "file.pem" }, "requestBinding" : "HTTP-POST", "responseSignatureAlgorithm" : "SHA-256", "ssoDebugEnabled" : true, "ssoUrl" : "https://123456789000.us.provider.com/samlp/12345678901234567890123456789012", "status" : "INACTIVE" } ], "totalCount": 1 }
OIDC 요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?protocol=OIDC"
OIDC 응답 예시
{ "links": [ { "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/identityProviders?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "associatedDomains": [], "associatedOrgs": [], "audienceClaim": [ "audience" ], "clientId": "clientId", "description": "OIDC IdP response example", "displayName": "OIDC IdP", "groupsClaim": "groups", "id": "32b6e34b3d91647abb20e7b8", "issuerUri": "issuer.com", "oktaIdpId": null, "protocol": "OIDC", "requestedScopes": [ "scopes" ], "userClaim": "sub" } ], "totalCount": 1 }