- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Remove the specified pending invitation to your organization.
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 delete <invitationId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | true | Unique 24-digit string that identifies the invitation. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--force | false | Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. | |
-h, --help | false | help for delete | |
--orgId | string | false | Organization ID 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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Invitation '<Name>' deleted
Examples
# Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the organization with the ID 5f71e5255afec75a3d0f96dc: atlas organizations invitations delete 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc