Modifica los roles o la descripción de la API Key de la organización especificada.
Cuando modifiques los roles de la clave API de una organización con este comando, los valores que especifiques sobrescriben los roles existentes asignados a la clave API.
Para ver los posibles valores del argumento apiKeyId, ejecute mongocli organizations apiKeys list.
Para utilizar este comando, hay que autenticarse con una cuenta de usuario o una clave API con el rol de Administrador de la Organización de Usuarios.
Sintaxis
mongocli iam organizations apiKeys assign <apiKeyId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
apiKeyId | string | true | string única de 24 dígitos que identifica tu clave API. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--desc | string | false | Descripción de la clave de API. |
-h, --help | false | ayuda para asignar | |
--orgId | string | false | Identificador de la Organización a usar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
-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, usa la opción -o json. |
--role | Cuerdas | false | Rol o roles que deseas asignar a la clave API. Para asignar más de un rol, especifica cada rol con una bandera de rol independiente o especifica todos los roles como una lista separada por comas utilizando una sola bandera de rol. Para aprender qué valores acepta el CLI, consulta el Items Enum para roles en la especificación de API de Atlas: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#etiqueta/Programmatic-API-Keys/operación/createApiKey/. El uso de esta bandera reemplaza los datos preexistentes. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará del archivo de configuración. Para aprender sobre los perfiles para MongoCLI, consulta https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
API Key '<ID>' successfully updated.
Ejemplos
# Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json