mongocli iam projects invitations describe
Return the details for the specified pending invitation to your project.
To use this command, you must authenticate with a user account or an API key with the Project User Admin role.
Syntax
Command Syntax
mongocli iam projects invitations describe <invitationId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | true | Unique 24-digit string that identifies the invitation. |
Options
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. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID USERNAME CREATED AT EXPIRES AT <ID> <Username> <CreatedAt> <ExpiresAt>
Examples
# Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the project with the ID 5f71e5255afec75a3d0f96dc: mongocli iam projects invitations describe 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --output json