Docs Menu

Docs HomeAtlas Command Line Interface

atlas organizations invitations delete

On this page

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

Remove the specified pending invitation to your organization.

To use this command, you must authenticate with a user account or an API key that has the Organization User Admin role.

atlas organizations invitations delete <invitationId> [options]
Name
Type
Required
Description
invitationId
string
true
Unique 24-digit string that identifies the invitation.
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. Overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

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

Invitation '<Name>' deleted
# Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the organization with the ID 5f71e5255afec75a3d0f96dc:
atlas organizations invitations delete 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc
←  atlas organizations invitationsatlas organizations invitations describe →

Specify your version