atlas organizations invitations list
Return all pending invitations to 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 use this command, you must authenticate with a user account or an API key with the Organization User Admin role.
Syntax
atlas organizations invitations list [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
string | false | Email address for the user. | |
-h, --help | false | help for list | |
--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. |
Examples
# Return a JSON-formatted list of pending invitations to the organization with the ID 5f71e5255afec75a3d0f96dc: atlas organizations invitations list --orgId 5f71e5255afec75a3d0f96dc --output json