atlas organizations apiKeys describe

Return the details for the specified API key for your organization.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

To view possible values for the ID argument, run atlas organizations apiKeys list.

To use this command, you must authenticate with a user account or an API key with the Organization Member role.

Syntax

Command Syntax

atlas organizations apiKeys describe <ID> [options]

Arguments

Name	Type	Required	Description
ID	string	true	Unique 24-digit string that identifies your API key.

Options

Name	Type	Required	Description
-h, --help		false	help for describe
--orgId	string	false	Organization ID to use. This option overrides the settings in the configuration file or environment variable.
-o, --output	string	false	Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.

Inherited Options

Name	Type	Required	Description
-P, --profile	string	false	Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Output

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

ID     DESCRIPTION   PUBLIC KEY    PRIVATE KEY
<Id>   <Desc>        <PublicKey>   <PrivateKey>

Examples

# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json

Back

delete

list