MOmongodb
Organizations

Create Invitation for One MongoDB Cloud User in One Organization

Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization.

Note: Invitation management APIs are deprecated. Use Add One MongoDB Cloud User to One Organization to invite a user.

post/api/atlas/v2/orgs/{orgId}/invites

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

orgIdstring required
Example:4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

rolesstring[]

One or more organization level roles to assign to the MongoDB Cloud user.

teamIdsstring[]

List of teams to which you want to invite the desired MongoDB Cloud user.

usernamestring email

Email address that belongs to the desired MongoDB Cloud user.

Example request

{
  "groupRoleAssignments": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.