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

1개의 연결된 조직 업데이트

이 페이지의 내용

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

federationSettings 리소스를 사용하면 연합 인증 구성을 위해 연결된 조직 하나를 업데이트할 수 있습니다.

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

필수 역할

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

Resource

PATCH /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/

요청 경로 매개변수

이름
유형
설명

FEDERATION-SETTINGS-ID

문자열

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

ORG-ID

문자열

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

요청 쿼리 매개변수

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

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

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

이름
설명

status

HTTP 응답 코드

content

예상되는 응답 본문

false

요청 본문 매개변수

이름
유형
필요성
설명

domainAllowList

배열

옵션

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

요청에 domainAllowList 필드를 제공하면 제공하는 배열이 현재 domainAllowList 을 대체합니다.

domainRestrictionEnabled

부울

필수 사항

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

identityProviderId

문자열

필수 사항

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

생략되거나 값이 null 인 경우 MongoDB Cloud는 orgId 로 지정된 조직을 IdP 에서 연결 해제합니다.

orgId

문자열

필수 사항

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

postAuthRoleGrants

배열

옵션

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

요청에 postAuthRoleGrants 필드를 제공하면 제공하는 배열이 현재 postAuthRoleGrants 을 대체합니다.

roleMappings

배열

옵션

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

요청에 roleMappings 필드를 제공하면 제공하는 배열이 현재 roleMappings 을 대체합니다.

응답

이름
유형
설명

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 PATCH "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}" \
     --data '
       {
         "domainRestrictionEnabled": false,
         "identityProviderId": "0oa7i0grsgbwJiIyw357",
         "orgId": "5df7a168f10fab3a149357fb",
         "roleMappings": [
           {
             "externalGroupName": "example",
             "id": "61e89721b827b56c845ff44c",
             "roleAssignments": [
               {
                 "groupId": null,
                 "orgId": "5df7a168f10fab3a149357fb",
                 "role": "ORG_OWNER"
               }
             ]
           }
         ]
       }'

응답 예시

{
  "domainAllowList": [],
  "domainRestrictionEnabled": false,
  "identityProviderId": "0oa7i0grsgbwJiIyw357",
  "orgId": "5df7a168f10fab3a149357fb",
  "postAuthRoleGrants": [
    "ORG_OWNER"
  ],
  "roleMappings": [
    {
      "externalGroupName": "example",
      "id": "61e89721b827b56c845ff44c",
      "roleAssignments": [
        {
          "groupId": null,
          "orgId": "5df7a168f10fab3a149357fb",
          "role": "ORG_OWNER"
        }
      ]
    }
  ],
  "userConflicts": null
}

돌아가기

조직 반환

다음

조직 제거