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

연결된 모든 조직 반환

이 페이지의 내용

  • 필수 역할
  • Resource
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 응답 문서
  • 결과 내장된 문서
  • 요청 예시
  • 응답 예시

federationSettings 리소스를 사용하면 연합 인증 구성에 대해 연결된 모든 조직 을 반환할 수 있습니다.

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

필수 역할

이 엔드포인트를 호출하려면 페더레이션 구성에서 하나 이상의 연결된 조직에 대한 Organization Owner 역할이 있어야 합니다.

Resource

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/

요청 경로 매개변수

이름
유형
설명

FEDERATION-SETTINGS-ID

문자열

페더레이션 인증 구성을 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

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

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

pageNum

숫자

옵션

결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.

1

itemsPerPage

숫자

옵션

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

결과 목록을 반환하는 엔드포인트의 경우 content 객체는 엔벨로프입니다. Cloud Manager가 status 필드를 응답 본문에 추가합니다.

false

backupJobsEnabledOnly

부울

옵션

데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다.

true

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서에는 결과 객체 배열, 링크 객체 배열 및 조회된 결과 객체의 총 개수가 포함됩니다.

이름
유형
설명

결과

객체 배열

결과 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 입니다.

링크

객체 배열

하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 links 배열에는 self 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.

총 개수

integer

결과 집합에 포함된 총 항목 수입니다. 전체 결과 집합이 페이지로 매겨진 경우 결과 배열에 있는 객체 수보다 클 수 있습니다.

결과 내장된 문서

result 배열의 각 문서에는 연결된 각 조직에 대한 페더레이션 인증 구성이 포함되어 있습니다.

이름
유형
설명

domainAllowList

배열

조직 사용자가 로그인할 수 있는 승인된 도메인이 포함된 목록입니다.

domainRestrictionEnabled

부울

연결된 조직에 대해 도메인 제한이 활성화되어 있는지 여부를 나타내는 플래그입니다.

userConflicts "domainRestrictionEnabled": false 일 때 null 을 반환합니다.

identityProviderId

문자열

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

orgId

문자열

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

postAuthRoleGrants

배열

연결된 조직에서 IdP 를 통해 인증하는 사용자에게 부여된 기본 역할 이 포함된 목록입니다.

roleMappings

배열

이 조직에 구성된 역할 매핑이 포함된 목록입니다.

userConflicts

배열

허용 목록의 어떤 도메인과도 일치하지 않는 사용자 이름이 포함된 목록입니다.

userConflicts "domainRestrictionEnabled": false 일 때 null 을 반환합니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

응답 예시

{
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}

돌아가기

구성 반환

다음

조직 반환