Devuelve los detalles de la clave de API especificada para tu organización.
Para ver los posibles valores del argumento ID, ejecutar mongocli organizations apiKeys list.
Para usar este comando, debes autenticarte con una cuenta de usuario o una clave API que tenga el rol de Miembro de la Organización.
Sintaxis
mongocli iam organizations apiKeys describe <ID> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID | string | true | string única de 24 dígitos que identifica tu clave API. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --help | false | ayuda para describir | |
--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. |
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. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
ID DESCRIPTION PUBLIC KEY PRIVATE KEY <ID> <Desc> <PublicKey> <PrivateKey>
Ejemplos
# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json