Modifica los roles y la descripción de una clave API global.
Sintaxis
mongocli iam globalApiKeys update <ID> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID | string | true | string única de 24 dígitos que identifica la clave global API. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--desc | string | true | Descripción de la clave de API. |
-h, --help | false | ayuda para actualizar | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--role | Cuerdas | true | Rol o roles que deseas asignar a la clave de API. Para asignar más de un rol, puedes especificar cada rol con una bandera de rol separada o especificar todos los roles como una lista separada por comas usando una sola bandera de rol. Los valores válidos son: GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN, GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY, GLOBAL_USER_ADMIN. La activación de este indicador sustituye los datos existentes. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará del archivo de configuración. Para aprender más sobre los perfiles para MongoCLI, consulta https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Ejemplos
# Modify the roles and description for the global API key with the ID 5f5bad7a57aef32b04ed0210: mongocli iam globalApiKeys update 5f5bad7a57aef32b04ed0210 --desc "My Sample Global API Key" --role GLOBAL_MONITORING_ADMIN --output json