更新一个身份提供程序
已弃用
更新指定联合中的一个身份提供程序。要使用此资源，请求的服务帐户或 API 密钥必须在连接的组织之一中具有“组织所有者”角色。
注意：更改授权类型和/或更新授权声明可能会禁止当前用户和/或组访问数据库。
路径参数
-
用于标识联合的唯一的 24 位十六进制数字字符串。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
标识要连接的身份提供者的唯一字符串。如果使用在 11-15-2023 之前的 API 版本，请使用旧版 20-十六进制数字 ID。点击已配置身份提供者的 IdP ID 行中的信息图标，即可在联合管理控制台>身份提供者选项卡中找到该 ID。对于所有其他版本，请使用 24 位十六进制数字 id。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。
body
必需
要更新的身份供应商。
-
包含与身份提供程序关联的域的列表。
-
身份提供商的描述。
-
用于标识身份提供程序的人类可读标签。
最小长度为
1，最大长度为50。 -
指示身份提供者类型的字符串枚举。默认为 WORKFORCE。
值为
WORKFORCE或WORKLOAD。 -
用于标识 SAML 断言或 OIDC 元数据/发现文档 URL 的发布者的唯一字符串。
-
身份提供商当前证书的 PEM 文件信息。
-
指示身份提供程序协议的字符串枚举。要么是 SAML 要么是 OIDC。
值为
SAML或OIDC。 -
“SAML 身份验证请求协议 HTTP”方法绑定（POST 或 REDIRECT），“联合身份验证”用于发送身份验证请求。
值为
HTTP-POST或HTTP-REDIRECT。 -
联合身份验证用于对身份提供程序签名进行加密的签名算法。
值为
SHA-1或SHA-256。 -
身份提供程序的自定义 SSO URL。
-
标志，用于指示身份提供商是否已启用 SSO 调试。
-
指向 SAML 身份验证请求接收者的 URL。
-
字符串枚举，表示身份提供商是否处于活动状态。
值为
ACTIVE或INACTIVE。
PATCH /api/atlas/v2 /federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}
Atlas CLI
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"
}
响应示例 (200)
{
"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"
}
响应示例 (400)
{
"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"
}
响应示例 (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
"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"
}
响应示例 (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}