Asigne la clave API de la organización especificada a su proyecto y modifique los roles de la clave API para el proyecto.
Cuando modifica los roles de una clave API de organización con este comando, los valores que especifique sobrescriben los roles existentes asignados a la clave API.
Para ver los valores posibles para el argumento ID, ejecute atlas organisations apiKeys list.
Sintaxis
atlas projects apiKeys assign <ID> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID | string | true | Cadena única de 24dígitos que identifica su clave API. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --ayuda | false | ayuda para asignar | |
-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. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
--role | cadenas | true | Rol o roles que desea asignar a la clave API. Para asignar más de un rol, especifique cada rol con una marca de rol independiente o especifique todos los roles como una lista separada por comas usando una sola marca de rol. Para ver la lista completa de valores aceptados, consulte la enumeración de elementos del punto final de la API de Atlas correspondiente: https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectapikey. Para obtener más información sobre los roles de usuario a nivel de proyecto, consulte: https://dochub.mongodb.org/core/atlas-proj-roles. |
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, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
API Key successfully assigned.
Ejemplos
# Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json