mongocli iam globalApiKey describe

On this page

Syntax

Arguments
Options
Output
Examples

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

The iam globalApiKey describe command provides details about the specified Global API Key. You can also retrieve details about the key using the Ops Manager API.

Syntax

mongocli iam globalApiKey|globalApiKeys describe <api-key-id>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Note

Use -h or --help to view the command-line help for this command.

Arguments

Argument	Type	Description	Required?
`<api-key-id>`	string	Unique identifier of the Global API Key to describe.	yes

Options

Option	Type	Description	Required?
`--output`, `-o`	string	Command output format. Valid values are: `json` for output in JSON format `go-template` for custom output using the Go template `go-template-file` for custom output specified using Go template file If omitted, the command returns output in the default format.	no
`--profile`, `-P`	string	Name of the profile where your credentials are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI. You must have credentials with the `Global Read Only` role to retrieve details about a Global API Key.	no

Output

If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

ID         DESCRIPTION          PUBLIC KEY     PRIVATE KEY
<key-id>   <key-description>    <public-key>   <private-key>

For the complete list of JSON fields returned by the command, see the API reference. The default output only includes a subset of the fields returned by this command.

Examples

The following command describes a Global API Key using the default profile, which contains credentials for accessing the Ops Manager instance. The output is returned in the default format.

mongocli iam globalApiKey describe 5f5aa08257aef32b04ec588c

The previous command prints the following to the terminal.

ID                         DESCRIPTION         PUBLIC KEY   PRIVATE KEY
5f5aa08257aef32b04ec588c   My Global API key   abcdefgh     ********-****-****-f4d64595457e

The following command describes a Global API Key using the myOM profile, which contains credentials. The output is returned in JSON format.

mongocli iam globalApiKey describe 5f5aa08257aef32b04ec588c  -P myOM --output json

The previous command prints the following to the terminal in JSON format.

{
  "id": "5f5aa08257aef32b04ec588c",
  "desc": "My Global API key",
  "roles": [
    {
      "roleName": "GLOBAL_READ_ONLY"
    },
    {
      "roleName": "GLOBAL_USER_ADMIN"
    }
  ],
  "privateKey": "********-****-****-f4d64595457e",
  "publicKey": "abcdefgh"
}

Back

List Global API Keys

Update a Global API Key