Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / / /

Delete One Project Invitation

On this page

  • Required Roles
  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Deletes one pending invitation to the Cloud Manager project that you specify. You can't delete an invitation that a user has accepted.

You can successfully call this endpoint with the Project User Admin role.

Base URL: https://cloud.mongodb.com/api/public/v1.0

DELETE /groups/{GROUP-ID}/invites/{INVITATION-ID}
Path Element
Type
Necessity
Description

GROUP-ID

string

Required

Unique 24-hexadecimal digit string that identifies the project.

INVITATION-ID

string

Required

Unique 24-hexadecimal digit string that identifies the invitation.

The following query parameters are optional:

Name
Type
Necessity
Description
Default

pretty

boolean

Optional

false

envelope

boolean

Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name
Description

status

HTTP response code

content

Expected response body

false

This endpoint doesn't use HTTP request body parameters.

This endpoint does not have response elements.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
--header "Accept: application/json" \
--request DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invitations/{INVITATION-ID}"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 204 No Content
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

This endpoint returns an empty JSON object.

Back

Create Invitation