Docs Menu

Update 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

Updates one pending invitation to the Atlas project that you specify.

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

You can successfully call this endpoint with the Project Owner role.

https://cloud.mongodb.com/api/atlas/v1.0

PATCH /groups/{GROUP-ID}/invites
Path Element
Type
Necessity
Description
GROUP-ID
string
Required
Unique 24-hexadecimal digit string that identifies the project.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These 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:

status
HTTP response code
envelope
Expected response body
false
Body Parameter
Type
Necessity
Description
roles
array of strings
Required

Atlas roles to assign to the invited user.

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

Important

Atlas replaces the roles in the invitation with those that you provide in this request.

Ensure that you include all roles that you want to assign the user in this request.

username
string
Required
Username of the user whose invitation you want to update. In Atlas, an invited user's username is the email address to which Atlas sent the invitation.
Name
Type
Description
createdAt
string
Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
expiresAt
string

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

Tip

Users have 30 days to accept an invitation to an Atlas 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
Atlas user who invited username to the project.
roles
array of strings

Atlas roles to assign to the invited user.

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

username
string

Email address to which Atlas sent the invitation.

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/invites/{INVITATION-ID}?pretty=true" \
--data '
{
"roles": [
"GROUP_OWNER"
],
"username": "jane.smith@example.com"
}'
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}
1{
2 "createdAt": "2021-02-18T18:51:46Z",
3 "expiresAt": "2021-03-20T18:51:46Z",
4 "groupId": "5f0e15e3d52a043fed8b1c92",
5 "groupName": "group",
6 "id": "602eb7429955214668d5b025",
7 "inviterUsername": "admin@example.com",
8 "roles": [
9 "GROUP_OWNER"
10 ],
11 "username": "jane.smith@example.com"
12}
Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.