Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu

atlas api federatedAuthentication updateRoleMapping

Actualiza una asignación de roles en la organización especificada en la federación especificada.

El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.

Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operación/operation-updatefederationsettingconnectedorgconfigrolemapping.

Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.

Sintaxis del comando
atlas api federatedAuthentication updateRoleMapping [options]
Nombre
Tipo
Requerido
Descripción

--envelope

envelope

false

Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

--federationSettingsId

string

true

string única de 24 dígitos hexadecimales que identifica a tu federación.

--file

string

false

ruta a tu archivo de solicitud de API. Déjelo vacío para utilizar la entrada estándar en su lugar; debe proporcionar uno u otro, pero no ambos.

-h, --help

false

ayuda para updateRoleMapping

--id

string

true

string única de 24 dígitos hexadecimales que identifica la asignación de rol que desea actualizar.

--orgId

/orgs

true

string única de 24dígitos hexadecimales que identifica a la organización que contiene los proyectos. Use el endpoint [/orgs](#etiqueta/Organizations/operación/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

-o, --output

string

false

formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON".

--outputFile

string

false

archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)

--versión

string

false

Versión de API que se utilizará al llamar a los puntos finales de la API de Atlas [opciones: "2023-01-01"]. Si el usuario no la especifica, se utilizará por defecto la última versión o el valor de configuración api_version del perfil, si está definido. Este valor por defecto es "2023-01-01".

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.