Docs Menu
Docs Home
/ /
MongoDB CLI
/ / / /

mongocli iam projects invitations update

On this page

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

Modifies the details of the specified pending invitation to your project.

You can use either the invitation ID or the user's email address to specify the invitation.

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

Command Syntax
mongocli iam projects invitations update [invitationId] [options]
Name
Type
Required
Description
invitationId
string
false
Unique 24-digit string that identifies the invitation.
Name
Type
Required
Description
--email
string
false
Email address for the user.
-h, --help
false
help for update
-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.
--role
strings
true
User's roles for the associated organization. To learn which values MCLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. Passing this flag replaces preexisting data.
Name
Type
Required
Description
-P, --profile
string
false

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

Invitation <ID> updated.
# Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc:
mongocli projects invitations update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json
# Modify the invitation for the user with the email address user@example.com to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc:
mongocli projects invitations update --email user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json
← mongocli iam projects invitations list