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

Get All Project Invitations

On this page

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

Retrieves all pending invitations to the specified Cloud Manager project.

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

GET /groups/{GROUP-ID}/invites

Request Path Parameters

Path Element
Type
Necessity
Description

GROUP-ID

string

Required

Unique 24-hexadecimal digit string that identifies the project.

Request Query Parameters

The following query parameters 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 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

username

string

Optional

Email address of the invited user. This is the address to which Cloud Manager sent the invite.

If omitted, Cloud Manager returns all pending invitations.

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

The response JSON document includes an array of objects. Each object represents one invitation to the Cloud Manager project.

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true"

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  {
3    "createdAt": "2021-02-18T18:51:46Z",
4    "expiresAt": "2021-03-20T18:51:46Z",
5    "groupId": "{GROUP-ID}",
6    "groupName": "group",
7    "id": "{INVITATION-ID}",
8    "inviterUsername": "admin@example.com",
9    "roles": [
10      "GROUP_OWNER"
11    ],
12    "username": "jane.smith@example.com"
13  },
14  {
15    "createdAt": "2021-02-18T21:05:40Z",
16    "expiresAt": "2021-03-20T21:05:40Z",
17    "groupId": "{GROUP-ID}",
18    "groupName": "group",
19    "id": "{INVITATION-ID}",
20    "inviterUsername": "admin@example.com",
21    "roles": [
22      "GROUP_READ_ONLY"
23    ],
24    "username": "john.smith@example.com"
25  }
26]

Back

Delete Invitation

Next

Get One Invitation