mongocli iam project list¶
The mongocli iam project list
command retrieves projects in an
organization using the specified profile.
You must have the Organization Owner
role to retrieve all projects
in an organization. If you have lesser permissions, the command
retrieves only the project for which you are the Project Owner
.
For Ops Manager deployments, you can also use a Personal API Key to retrieve all projects in all organizations.
Syntax¶
mongocli iam project list [ --orgId <organization-ID> ] [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --limit <integer> ] [ --page <integer> ]
Use -h
or --help
to view the command-line help for
this command.
Options¶
Option | Type | Description | Required? |
---|---|---|---|
--orgId | string | Unique identifier of the organization that contains the projects
to retrieve. If omitted, retrieves all projects to which the
API key has access. | no |
--output , -o | string | Command output format. Valid values are:
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 |
--limit | integer | Number of projects to return from the result set.
| no |
--page | integer | Starting chunk of projects to return from the result set. The
| no |
Output¶
The command prints the following fields in the specified format to the terminal if the command succeeds. If the command returns errors, see Troubleshooting for recommended solutions.
The JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Field | Description |
---|---|
links | Array includes one or more links to sub-resources
and/or related resources. The relations between URL |