Actualiza un proveedor de identidad en la federación especificada. Para usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de propietario de la organización en una de las organizaciones conectadas.
Nota: Cambiar los tipos de autorización y/o actualizar las reclamaciones de autorización puede impedir que los usuarios y/o grupos actuales accedan a la base de datos.
Nota: Al desactivar un proveedor de identidad SAML conectado a una organización, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario de la organización. Si el proveedor de identidad está conectado a varias organizaciones, la solicitud fallará.
Parámetros de ruta
-
Cadena de dígitos hexadecimales 24única que identifica su federación.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Cadena única que identifica al proveedor de identidad con el que se conectará. Si usa una versión de API anterior a 11-15-2023, use el ID hexadecimal 20heredado. Este ID se puede encontrar en la pestaña Proveedores de identidad de la Consola de administración de federación, haciendo clic en el icono de información en la fila ID de IdP de un proveedor de identidad configurado. Para todas las demás versiones, use el ID hexadecimal 24.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false.
Cuerpo
Requerido
El proveedor de identidad que desea actualizar.
-
Lista que contiene los dominios asociados al proveedor de identidad.
-
La descripción del proveedor de identidad.
-
Etiqueta legible por humanos que identifica al proveedor de identidad.
La longitud mínima es
1, la longitud máxima es50. -
Enumeración de cadena que indica el tipo de proveedor de identidad. El valor predeterminado es WORKFORCE.
Los valores son
WORKFORCEoWORKLOAD. -
Cadena única que identifica al emisor de la URL del documento de descubrimiento/metadatos de OIDC o de la aserción SAML.
-
Información del archivo PEM para los certificados actuales del proveedor de identidad.
-
Enumeración de cadena que indica el protocolo del proveedor de identidad (SAML u OIDC).
Los valores son
SAMLoOIDC. -
Enlace del método HTTP del Protocolo de solicitud de autenticación SAML (POST o REDIRECT) que utiliza la autenticación federada para enviar la solicitud de autenticación.
Los valores son
HTTP-POSToHTTP-REDIRECT. -
Algoritmo de firma que utiliza la autenticación federada para cifrar la firma del proveedor de identidad.
Los valores son
SHA-1oSHA-256. -
URL de SSO personalizada para el proveedor de identidad.
-
Bandera que indica si el proveedor de identidad tiene habilitada la depuración de SSO.
-
URL que apunta al receptor de la solicitud de autenticación SAML.
-
Enumeración de cadena que indica si el proveedor de identidad está activo.
Los valores son
ACTIVEoINACTIVE.
atlas api federatedAuthentication updateIdentityProvider --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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-01-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-01-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": "2026-05-04T09:42:00Z",
"notBefore": "2026-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": "string"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "32b6e34b3d91647abb20e7b8"
}
]
}
],
"audienceUri": "string",
"createdAt": "2026-05-04T09:42:00Z",
"description": "string",
"displayName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "string",
"pemFileInfo": {
"certificates": [
{
"notAfter": "2026-05-04T09:42:00Z",
"notBefore": "2026-05-04T09:42:00Z"
}
],
"fileName": "string"
},
"protocol": "SAML",
"requestBinding": "HTTP-POST",
"responseSignatureAlgorithm": "SHA-1",
"slug": "string",
"ssoDebugEnabled": true,
"ssoUrl": "string",
"status": "ACTIVE",
"updatedAt": "2026-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": 405,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Method Not Allowed",
"errorCode": "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}