Actualiza una configuración de organización vinculada de la federación especificada. Para usar este recurso, la Cuenta de servicio o API Key solicitante debe 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 campo domainRestrictionEnabled tiene un valor por defecto de falso si no se proporciona en la solicitud.
Nota: Si no se proporciona el campo identityProviderId, se desconectará la organización y el proveedor de identidad.
Nota: Los proveedores de identidad de acceso a datos actualmente conectados que falten en el campo dataAccessIdentityProviderIds serán desconectados.
Parámetros de path
-
string única de 24 dígitos hexadecimales que identifica a tu federación.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Unique 24-hexadecimal digit string that identifies the connected organización configuration to actualizar.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false.
Cuerpo
Requerido
La configuración de organización conectada que deseas 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 heredada de 20dígitos hexadecimales que identifica al proveedor de identidad de acceso de Interfaz de Usuario con el que se asocia esta configuración de organización conectada. Este id se puede encontrar dentro de la Consola de Gestión de Federaciones > pestaña Proveedores de Identidad haciendo clic en el icono de información en la fila IdP ID 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 después de la autenticación. Los roles son etiquetas legibles por humanos que identifican la colección de privilegios que MongoDB Nube otorga a un usuario específico de MongoDB Nube. Estos roles solo pueden ser roles 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_ADMINoORG_READ_ONLY. -
Mapeos de roles que están configurados en esta organización.
-
Lista que contiene los usuarios que tienen una dirección de correo electrónico que no coincide con ningún dominio en la lista permitida.
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/federationSettings/55fa922fb343282757d9554e/connectedOrgConfigs/32b6e34b3d91647abb20e7b8' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"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",
"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"
}