Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
리소스
/
연합 인증

1개의 조직에 대해 페더레이션 구성 반환

이 페이지의 내용

  • 필수 역할
  • Resource
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 요청 예시
  • 응답 예시

federationSettings 리소스를 사용하면 조직 한 개에 대한 페더레이션 인증 구성 을 반환할 수 있습니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

필수 역할

이 엔드포인트를 호출하려면 Organization Owner 역할이 있어야 합니다.

Resource

GET /orgs/{ORG-ID}/federationSettings

요청 경로 매개변수

이름
유형
설명

ORG-ID

문자열

조직을 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값

pretty

부울

옵션

응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름
설명

status

HTTP 응답 코드

content

예상되는 응답 본문

false

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

이름
유형
설명

federatedDomains

문자열 배열

조직의 ID 제공자와 연결된 도메인이 포함된 목록입니다.

hasRoleMappings

부울

이 조직에 역할 매핑이 구성되어 있는지 여부를 나타내는 플래그입니다.

역할 매핑에 대해 자세히 알아보려면 IdP 그룹에 대한 managed Cloud Manager 역할 매핑을 참조하세요.

id

문자열

이 연합을 식별하는 고유한 24자리 16진수 문자열입니다.

identityProviderId

문자열

이 조직에 연결된 ID 제공자를 식별하는 고유한 20자리 16진수 문자열입니다.

identityProviderStatus

문자열

ID 제공자가 활성 상태인지 여부를 나타내는 값입니다. Cloud Manager는 ID 제공자가 활성 상태이면 ACTIVE 를 반환하고 ID 제공자가 비활성 상태이면 INACTIVE 을 반환합니다.

요청 예시

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/orgs/{ORG-ID}/federationSettings"

응답 예시

{
  "federatedDomains": [
    "example.com"
  ],
  "hasRoleMappings": false,
  "id": "5e8cc670a16506712e0b1e95",
  "identityProviderId": "0oa8i0grsgbwDiIyw453",
  "identityProviderStatus": "INACTIVE"
}

돌아가기

연합 인증

다음

모든 조직 반환