mongocli iam team describe

On this page

Syntax

Options
Output
Example

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 mongocli iam team describe command retrieves information about a team specified by name or ID.

Syntax

mongocli iam team describe
     --id <team-id>
     --name <team-name>
     --orgId <organization-ID>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Note

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

Options

Option	Type	Description	Required?
`--id`	string	Unique identifier of the team.	Either `id` or `name` must be specified.
`--name`	string	Name of the team.	Either `id` or `name` must be specified.
`--orgId`	string	Unique identifier of the organization that contains the new team.	yes
`--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 that contains the access information. If omitted, uses the default profile.	no

Output

The command prints the following output in the specified format to the terminal if the command succeeds. If the command returns errors, see Troubleshooting for recommended solutions.

ID                         NAME
5f6a61ad7840ac2890424ce2   team1

Field	Description
`id`	The unique identifier of the team.
`name`	The name of the team.

Example

The following command retrieves information about a team named "myTeam" in an Atlas organization. It uses the default profile for accessing Atlas.

mongocli iam team describe --name "myTeam" \
  --orgId 5df27c15f10fab55fc6c1234 -o json

The previous command prints the following in the specified format to the terminal. For more information on these fields, see Output.

{
 "id": "5e44445ef10fab20b49c0f31",
 "name": "myTeam"
}

Back

List Teams

Delete a Team