• API >
• Public API Resources >
• Projects and Users >
• Projects >
• Create One Project Invitation

Create One Project Invitation

Retrieve details for one pending invitation 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

copy

POST /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.

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 envelope Expected response body	false

Request Body Parameters

Name	Type	Description
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. The user uses this email address as their Cloud Manager username if they accept this invitation.

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. Tip 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

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request POST "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 201 Created
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

{
  "createdAt": "2021-02-18T18:51:46Z",
  "expiresAt": "2021-03-20T18:51:46Z",
  "groupId": "{GROUP-ID}",
  "groupName": "group",
  "id": "{INVITATION-ID}",
  "inviterUsername": "admin@example.com",
  "roles": [
    "GROUP_OWNER"
  ],
  "username": "jane.smith@example.com"
}

←   Remove One User from One Project Delete One Project Invitation  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.