Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas api projects deleteProjectInvitation

On this page

  • Syntax
  • Options
  • Inherited Options

experimental: Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project.

You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteProjectInvitation'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation

Command Syntax
atlas api projects deleteProjectInvitation [options]
Name
Type
Required
Description

--envelope

false

flag that indicates whether Application wraps the response in an envelope JSON object

--groupId

string

true

unique 24-hexadecimal digit string that identifies your project

-h, --help

false

help for deleteProjectInvitation

--invitationId

string

true

unique 24-hexadecimal digit string that identifies the invitation

--output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--output-file

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--version

string

false

api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Name
Type
Required
Description

-P, --profile

string

false

Back

deleteProject