Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Resources
/
Projects & Users
/
Projects

Update One Project Invitation by Invitation ID

On this page

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

Updates one pending invitation by {INVITATION-ID} to the Cloud Manager project that you specify.

Use the Get All Project Invitations endpoint to retrieve IDs for all pending project invitations.

Required Roles

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

Resource

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

PATCH /groups/{GROUP-ID}/invites/{INVITATION-ID}

Request Path Parameters

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.

Request Query Parameters

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

Request Body Parameters

Body Parameter
Type
Necessity
Description
roles
array of strings
Required

Cloud Manager roles to assign to the invited user.

If the user accepts the invitation, Cloud Manager assigns these roles to them.

IMPORTANT: Cloud Manager replaces the roles in the invitation with the roles that you provide in this request. Ensure that you include all roles that you want to assign the user in this request.

Response

Name
Type
Description
createdAt
string
Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation.
expiresAt
string

Timestamp in ISO 8601 date and time format in UTC when the invitation expires.

Users have 30 days to accept an invitation to an Cloud Manager project.

groupId
string
Unique 24-hexadecimal digit string that identifies the project.
groupName
string
Name of the project.
id
string
Unique 24-hexadecimal digit string that identifies the invitation.
inviterUsername
string
Cloud Manager user who invited username to the project.
roles
array of strings

Cloud Manager roles to assign to the invited user.

If the user accepts the invitation, Cloud Manager assigns these roles to them.

username
string

Email address to which Cloud Manager sent the invitation.

If the user accepts the invitation, they use this email address as their Cloud Manager username.

Example Request

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites/{INVITATION-ID}?pretty=true" \
5     --data '
6       {
7         "roles": [
8           "GROUP_OWNER"
9         ]
10       }'

Example Response

Response Header

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 200 OK
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}

Response Body

1{
2  "createdAt": "2021-02-18T18:51:46Z",
3  "expiresAt": "2021-03-20T18:51:46Z",
4  "groupId": "{GROUP-ID}",
5  "groupName": "group",
6  "id": "{INVITATION-ID}",
7  "inviterUsername": "admin@example.com",
8  "roles": [
9    "GROUP_OWNER"
10  ],
11  "username": "jane.smith@example.com"
12}

Back

Get One Invitation

Next

Update Invitation