1개의 연합에서 1개의 조직 구성을 업데이트
지정된 연합에서 연결된 조직 구성 한 개를 업데이트합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 조직 소유자 역할이 있어야 합니다.
참고: 조직 구성에 연결된 멱등이 없는 경우 이 리소스를 사용하여 역할 매핑을 업데이트하거나 승인 역할 부여를 게시할 수 없습니다.
참고: domainRestrictionEnabled 필드는 요청에 제공되지 않은 경우 기본값 'false'로 설정됩니다.
참고: identityProviderId 필드를 제공하지 않으면 조직과 멱등의 연결이 끊어집니다.
참고: 현재 연결된 데이터 액세스 멱등이 dataAccessIdentityProviderIds 필드에서 누락된 경우 연결이 끊어집니다.
경로 매개변수
-
연합을 식별하는 고유한 24자리 16진수 문자열.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
업데이트할 연결된 조직 구성을 식별하는 고유한 24자리 16진수 문자열.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다.
body
필수 사항
업데이트하려는 연결된 조직 구성.
-
이 조직에서 데이터 액세스에 사용할 수 있는 멱등을 나타내는 고유 ID 컬렉션.
-
이메일 주소를 기반으로 조직에 가입할 수 있는 사용자를 제한하는 승인된 도메인입니다.
-
이 연결된 조직의 도메인 제한 사용 설정 여부를 나타내는 값.
-
연결된 이 조직 구성과 연결된 UI 액세스 멱등을 식별하는 레거시 20-16진수 문자열입니다. 이 ID는 페더레이션 '관리 콘솔' > '멱등' 탭에서 구성된 멱등의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다.
형식은
^([a-f0-9]{20})$패턴 과 일치해야 합니다. -
인증 후 이 조직의 사용자에게 부여되는 Atlas 역할. 역할은 MongoDB Cloud가 특정 MongoDB Cloud 사용자에게 부여하는 권한 모음을 식별하는 인간 판독 가능 레이블입니다. 이러한 역할은 조직별 역할만 가능합니다.
값은
ORG_OWNER,ORG_MEMBER,ORG_GROUP_CREATOR,ORG_BILLING_ADMIN,ORG_BILLING_READ_ONLY,ORG_STREAM_PROCESSING_ADMIN또는ORG_READ_ONLY입니다. -
이 조직에 구성된 역할 매핑입니다.
하나의 IdP와 MongoDB Cloud를 연결하는 매핑 설정입니다.
-
허용 목록에 있는 어떤 도메인과도 일치하지 않는 이메일 주소를 가진 사용자가 포함된 목록.
이 페더레이션 인증 에 연결된 MongoDB Cloud 사용자입니다.
atlas api federatedAuthentication updateFederationSettingConnectedOrgConfig --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateFederationSettingConnectedOrgConfigApiParams{}
sdkResp, httpResp, err := client.FederatedAuthenticationApi.
UpdateFederationSettingConnectedOrgConfigWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \
-d '{ <Payload> }'{
"dataAccessIdentityProviderIds": [
"string"
],
"domainAllowList": [
"string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "string",
"postAuthRoleGrants": [
"ORG_OWNER"
],
"roleMappings": [
{
"externalGroupName": "string",
"roleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string"
}
]
}{
"dataAccessIdentityProviderIds": [
"string"
],
"domainAllowList": [
"string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": [
"ORG_OWNER"
],
"roleMappings": [
{
"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "ORG_OWNER"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "32b6e34b3d91647abb20e7b8"
}
]
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}