Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas organizations describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Return the details for the specified organizations.

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

Command Syntax
atlas organizations describe <ID> [options]
Name
Type
Required
Description

ID

string

true

Unique 24-digit string that identifies the organization.

Name
Type
Required
Description

-h, --help

false

help for describe

-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.

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.

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

ID NAME
<Id> <Name>
# Return the JSON-formatted details for the organization with the ID 5e2211c17a3e5a48f5497de3:
atlas organizations describe 5e2211c17a3e5a48f5497de3 --output json

Back

delete