Docs Menu
Docs Home
/ /

Actualización de las claves API globales de IAM de Mongocli

Modificar los roles y la descripción de una clave API global.

Sintaxis del comando
mongocli iam globalApiKeys update <ID> [options]
Nombre
Tipo
Requerido
Descripción

ID

string

true

Cadena única de 24dígitos que identifica la clave API global.

Nombre
Tipo
Requerido
Descripción

--desc

string

true

Descripción de la clave API.

-h, --ayuda

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

cadenas

true

Rol o roles que desea asignar a la clave API. Para asignar más de un rol, puede especificar cada rol con una bandera de rol independiente o especificar todos los roles como una lista separada por comas usando una bandera de rol. Los valores válidos son GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN, GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY y GLOBAL_USER_ADMIN. Al pasar esta bandera, se reemplazan los datos preexistentes.

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file.

# 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

Volver

Lista

En esta página