하나의 멱등 업데이트
더 이상 사용되지 않습니다.
지정된 연합에서 자격 증명 공급자 하나를 업데이트합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.
참고: 권한 부여 유형 변경 및/또는 권한 부여 클레임 업데이트 시 현재 사용자 및/또는 그룹이 데이터베이스에 액세스하지 못할 수 있습니다.
경로 매개변수
-
연합을 식별하는 고유한 24자리 16진수 문자열.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
연결할 멱등을 식별하는 고유 문자열입니다. 2023년 11월 15일 이전의 API 버전을 사용하는 경우 레거시 20자리 16진수 ID를 사용합니다. 이 ID는 페더레이션 관리 콘솔 > 멱등 탭에서 구성된 ID 공급자의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다. 다른 모든 버전에서는 24자리 16진수 ID를 사용합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다.
body
필수 사항
업데이트하려는 멱등.
-
멱등과 연결된 도메인이 포함된 목록.
-
멱등에 대한 설명.
-
멱등을 식별하는 인간 판독 가능 레이블.
최소 길이는
1, 최대 길이는50입니다. -
멱등의 유형을 나타내는 문자열 열거형. 기본값은 WORKFORCE입니다.
값은
WORKFORCE또는WORKLOAD입니다. -
SAML 어설션 또는 OIDC 메타데이터/검색 문서 URL의 발급자를 식별하는 고유한 문자열.
-
ID 제공자의 현재 인증서에 대한 PEM 파일 정보.
-
멱등의 유형을 나타내는 문자열 열거형. SAML 또는 OIDC가 될 수 있습니다.
값은
SAML또는OIDC입니다. -
연합 인증이 인증 요청을 보내는 데 사용하는 SAML 인증 요청 프로토콜 HTTP 메서드 바인딩(POST 또는 REDIRECT).
값은
HTTP-POST또는HTTP-REDIRECT입니다. -
연합 인증이 멱등 서명을 암호화하는 데 사용하는 서명 알고리즘.
값은
SHA-1또는SHA-256입니다. -
멱등이 사용하는 사용자 지정 SSO URL입니다.
-
멱등의 SSO 디버그를 사용 설정 여부를 나타내는 플래그.
-
SAML 인증 요청 수신자를 가리키는 URL.
-
멱등의 활성 상태 여부를 나타내는 문자열 열거형.
값은
ACTIVE또는INACTIVE입니다.
atlas api federatedAuthentication updateFederationSettingIdentityProvider --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230201001/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.UpdateFederationSettingIdentityProviderApiParams{}
sdkResp, httpResp, err := client.FederatedAuthenticationApi.
UpdateFederationSettingIdentityProviderWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \
-d '{ <Payload> }'{
"associatedDomains": [
"string"
],
"description": "string",
"displayName": "string",
"idpType": "WORKFORCE",
"issuerUri": "urn:idp:default",
"pemFileInfo": {
"certificates": [
{
"content": "string",
"notAfter": "2025-05-04T09:42:00Z",
"notBefore": "2025-05-04T09:42:00Z"
}
],
"fileName": "string"
},
"protocol": "SAML",
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "https://example.com",
"status": "ACTIVE"
}{
"acsUrl": "string",
"associatedDomains": [
"string"
],
"associatedOrgs": [
{
"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"
}
]
}
],
"audienceUri": "string",
"createdAt": "2025-05-04T09:42:00Z",
"description": "string",
"displayName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "string",
"pemFileInfo": {
"certificates": [
{
"notAfter": "2025-05-04T09:42:00Z",
"notBefore": "2025-05-04T09:42:00Z"
}
],
"fileName": "string"
},
"protocol": "SAML",
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "string",
"status": "ACTIVE",
"updatedAt": "2025-05-04T09:42:00Z"
}{
"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"
}