Navigation

Invite One User to an Atlas Organization

Invites one user to the Atlas organization that you specify.

The user must accept the invitation to access the Atlas organization.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

You can successfully call this endpoint with the Organization Owner role.

https://cloud.mongodb.com/api/atlas/v1.0

POST /orgs/{ORG-ID}/invites
Path Element
Type
Necessity
Description
ORG-ID
string
Required
Unique 24-hexadecimal digit string that identifies the organization.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these 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 indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These 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:

status
HTTP response code
envelope
Expected response body
false
Body Parameter
Type
Necessity
Description
roles
array of strings
Required

Atlas roles to assign to the invited user.

If the user accepts the invitation, Atlas assigns these roles to them.

teamIds
array of strings
Optional
Unique 24-hexadecimal digit strings that identify the teams that you invite the user to join.
username
string
Required

Email address of the invited user. This is the address to which Atlas sends the invite.

If the user accepts the invitation, they log in to Atlas with this username.

Name
Type
Description
createdAt
string
Timestamp in ISO 8601 date and time format in UTC when 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 Atlas project.

id
string
Unique 24-hexadecimal digit string that identifies the invitation.
inviterUserName
string
Atlas user who invited username to the organization.
orgId
string
Unique 24-hexadecimal digit string that identifies the organization.
orgName
string
Name of the organization.
roles
array of strings

Atlas roles to assign to the invited user.

If the user accepts the invitation, Atlas assigns these roles to them.

teamId
array of strings
Unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
username
string

Email address to which Atlas sent the invitation.

If the user accepts the invitation, they use this email address as their Atlas username.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/invites?pretty=true" \
--data '
{
"roles": [
"ORG_MEMBER"
],
"username": "wyatt.smith@example.com"
}'
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}
1{
2 "createdAt": "2021-02-18T21:05:40Z",
3 "expiresAt": "2021-03-20T21:05:40Z",
4 "id": "602ed6a49a7b2379719b97f7",
5 "inviterUsername": "admin@example.com",
6 "orgId": "5df7a168f10fab3a149357fb",
7 "orgName": "jww-12-16",
8 "roles": [
9 "ORG_MEMBER"
10 ],
11 "teamIds": [],
12 "username": "wyatt.smith@example.com"
13}
Give Feedback