MongoDB/createOrgInvite

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

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

Manage create Org Invite.

Contract-preserving POST endpoint for create Org Invite in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.

All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.

Request

operationId
createOrgInvite
Server
https://cloud.mongodb.com
Authentication
ServiceAccounts, DigestAuth

Request parameters

envelope

queryboolean

envelope value in the Atlas Administration API contract.

orgId

pathstringrequired

org Id value in the Atlas Administration API contract.

4888442a3354817a7320eb61

pretty

queryboolean

pretty value in the Atlas Administration API contract.

Request body

OrganizationInvitationRequestrequired

Content-Type: application/vnd.atlas.2023-01-01+json

Properties: groupRoleAssignmentsrolesteamIdsusername

Responses

200

OrganizationInvitationapplication/vnd.atlas.2023-01-01+json

Successful supplier response.

Properties: createdAtexpiresAtgroupRoleAssignmentsidinviterUsernamelinksorgIdorgNamerolesteamIdsusername

400

ApiErrorapplication/json

Supplier response with HTTP status 400.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

401

ApiErrorapplication/json

Supplier response with HTTP status 401.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

403

ApiErrorapplication/json

Supplier response with HTTP status 403.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

404

ApiErrorapplication/json

Supplier response with HTTP status 404.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

429

ApiErrorapplication/json

Supplier response with HTTP status 429.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

500

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "groupRoleAssignments": {
    "groupId": "32b6e34b3d91647abb20e7b8"
  },
  "id": "32b6e34b3d91647abb20e7b8",
  "links": {
    "href": "https://cloud.mongodb.com/api/atlas",
    "rel": "self"
  },
  "orgId": "32b6e34b3d91647abb20e7b8"
}