Navigation

Get All Users Assigned to a Team

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

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.

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

GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users
Path Element
Required/Optional
Description
ORG-ID
Required
The unique identifier for the organization associated with the team.
TEAM-ID
Required
The unique identifier of the team whose user membership you want to retrieve.

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name
Type
Necessity
Description
Default
pageNum
integer
Optional
Page number, starting with one, that Atlas returns of the total number of objects.
1
itemsPerPage
integer
Optional
Number of items that Atlas returns per page, up to a maximum of 500.
100
includeCount
boolean
Optional
Flag that indicates whether Atlas returns the totalCount parameter in the response body.
true
pretty
boolean
Optional
Flag that indicates whether Atlas returns the JSON response in the prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether Atlas wraps 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.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false

This endpoint does not use HTTP request body parameters.

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 of objects
One object for each item detailed in the results Embedded Document section.
links
array of objects

One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification

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

Each element in the result array is one user assigned to the team.

Name
Type
Description
emailAddress
string
The email address associated to the user.
firstName
string
The first name of the user.
id
string
The unique identifier for the team.
lastName
string
The last name of the user.
links
object array

One or more links to sub-resources and/or related resources. The relation-types between URLs are explained in the Web Linking Specification.

roles
array
Each object in the roles array represents the Atlas organization role the user has for the associated orgId or groupId.
roles.orgId
string
ID of the organization where the user has the assigned roles.roleName organization role.
roles.groupId
string
ID of the project where the user has the assigned roles.roleName project role.
roles.roleName
string
The organization role assigned to the user for the specified roles.orgId or roles.groupId.
teamsId
array
Array of string IDs for each team the user is a member of.
username
string
Username associated to the user.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -i \
--header "Accept: application/json" \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true"
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100",
"rel": "self"
}
],
"results": [
{
"emailAddress": "AtlasUser@example.com",
"firstName": "Atlas",
"id": "{USER-ID}",
"lastName": "User",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}",
"rel": "self"
}
],
"roles": [
{
"groupId": "{GROUP-ID}",
"roleName": "GROUP_OWNER"
},
{
"orgId": "{ORG-ID}",
"roleName": "ORG_OWNER"
}
],
"teamIds": [
"{TEAM-ID}"
],
"username": "AtlasUser@example.com"
}
],
"totalCount": 1
}
Give Feedback