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 valores posibles para el argumento apiKeyId, ejecute atlas organisations apiKeys list.
Para usar este comando, debes autenticarte con una cuenta de usuario, una cuenta de servicio o una clave de API con el rol de Administrador de usuarios de la organización.
Sintaxis
atlas 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, use la opción -o json. |
--role | Cuerdas | false | Rol o roles que deseas asignar a la clave de API. Para asignar más de un rol, especifica cada rol con una bandera de rol separada o especifica todos los roles como una lista separada por comas usando una sola bandera de rol. Para la lista completa de valores aceptados, consulta el Enum de Items para el endpoint correspondiente de la API de Atlas: https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikey. Para obtener más información sobre los roles de usuario a nivel de organización, consulte: https://dochub.mongodb.org/core/atlas-org-roles. Pasar esta bandera reemplaza los datos preexistentes. |
Opciones heredadas
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 la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
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: atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json