Actualiza la configuración de una organización conectada de la federación especificada. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario de la organización.
Nota: Si la configuración de la organización no tiene un proveedor de identidad asociado, no podrá usar este recurso para actualizar asignaciones de roles ni para publicar concesiones de roles de autorización.
Nota: El domainRestrictionEnabled campo tiene como valor predeterminado falso si no se proporciona en la solicitud.
Nota: Si identityProviderId no se proporciona el campo, desconectará la organización y el proveedor de identidad.
Nota: Los proveedores de identidad de acceso a datos conectados actualmente que no estén en el dataAccessIdentityProviderIds campo se desconectarán.
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 de dígitos hexadecimales 24única que identifica la configuración de la organización conectada que se actualizará.
El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
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.
La configuración de la organización conectada que desea actualizar.
La colección de ID únicos que representan a los proveedores de identidad que pueden utilizarse para acceder a los datos de esta organización.
Dominios aprobados que restringen a los usuarios que pueden unirse a la organización en función de sus direcciones de correo electrónico.
Valor que indica si la restricción de dominio está habilitada para esta organización conectada.
Cadena de dígitos hexadecimales heredada 20que identifica el proveedor de identidad de acceso a la interfaz de usuario asociado a esta configuración de organización conectada. 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.
El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{20})$.
Roles de Atlas que se otorgan a un usuario de esta organización tras la autenticación. Los roles son etiquetas legibles que identifican el conjunto de privilegios que MongoDB Cloud otorga a un usuario específico. Estos roles solo pueden ser específicos de la organización.
Los valores son ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN o ORG_READ_ONLY.
Asignaciones de roles que están configuradas en esta organización.
Configuraciones de mapeo que vinculan un IdP y MongoDB Cloud.
Lista que contiene los usuarios que tienen una dirección de correo electrónico que no coincide con ningún dominio de la lista permitida.
Usuario de MongoDB Cloud vinculado a esta autenticación federada.
atlas api federatedAuthentication updateConnectedOrgConfig --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.2025-03-12+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.2025-03-12+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": "string"
}
]
}
],
"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": "string"
}
]
}
],
"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"
}