- API >
- Public API Resources >
- Projects and Users >
- Projects >
- Get All Project Invitations
Get All Project Invitations¶
On this page
Retrieves all unaccepted invitations to the specified Ops Manager project.
Required Roles¶
You can successfully call this endpoint with the
Project User Admin
role.
Resource¶
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
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:
|
false |
username | string | Optional | Email address of the invited user. This is the address to which Ops Manager sent the invite. If omitted, Ops Manager returns all unaccepted invitations. |
---|
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results |
array | Array includes one object for each item detailed in the results Embedded Document section. |
links |
array | Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount |
number | Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result represents one invitation to the Ops Manager project.
Name | Type | Description |
---|---|---|
createdAt | string | Timestamp in ISO 8601 date and time format in UTC when MongoDB 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 MongoDB 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 | MongoDB Atlas user who invited username to the project. |
roles | array of strings | MongoDB Atlas roles to assign to the invited user. If the user accepts the invitation, MongoDB Atlas assigns these roles to them. |
username | string | Email address to which MongoDB Atlas sent the invitation. If the user accepts the invitation, they use this email address as their MongoDB Atlas username. |