Docs Menu

Docs HomeMongoDB Ops Manager

Get All Organization Users

On this page

  • Syntax
  • Request Path Parameters
  • Request Query Parameters
  • Response Elements
  • Example Request
  • Request
  • Response

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/users
Parameter
Required/Optional
Description
ORG-ID
Required.
The unique identifier for the organization whose user information you want to retrieve.
Field
Required/Optional
Description
pageNum
Optional.

The page to return.

Defaults to 1.

itemsPerPage
Optional.

Number of items to return per page, up to a maximum of 500.

Defaults to 100.

envelope
Optional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

pretty
Optional

A boolean that specifies whether or not to return a "pretty-printed" JSON document.

Defaults to false.

If you set the query element envelope to true, the response is wrapped by the content object.

The HTTP response returns a JSON document that includes the following objects:

An array of documents, each representing one Organization user.

Name
Description
country
The country where the user lives.
emailAddress
The user's email address.
firstName
The user's first name.
lastName
ID of the Ops Manager project the user belongs to.
id
The user's id.
links
One or more links to sub-resources and/or related resources.
mobileNumber
The user's mobile phone number.
username
The username for authenticating to MongoDB.
roles
An array of the user's roles within the Organization and for each Project to which the user belongs.
roles.{ENTITY-ID}
The {ENTITY-ID} represents the Organization or Project to which this role applies. Possible values are: orgId or groupId.
roles.roleName

The name of the role. The users resource returns all the roles the user has in either Ops Manager or MongoDB Atlas. Possible values are:

  • Organization Roles

    Role Value in API
    Role
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_READ_ONLY
  • Project Roles

    Note

    Groups and projects are synonymous terms.

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

teamIds
An array of the team ids for the organization.

An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information.

The total number of items in the result set. This value may be higher than the number of objects in the results array if the entire result set is paginated.

curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"
{
"links" : [ ... ],
"results" : [
{
"country": "US",
"emailAddress": "someone@example.com",
"firstName": "John",
"id": "59db8d1d87d9d6420df0613a",
"lastName": "Smith",
"links": [ ... ],
"mobileNumber": "123-456-7890",
"roles": [{
"groupId": "59ea02e087d9d636b587a967",
"roleName": "GROUP_OWNER"
}, {
"groupId": "59db8d1d87d9d6420df70902",
"roleName": "GROUP_OWNER"
}, {
"orgId": "59db8d1d87d9d6420df0613f",
"roleName": "ORG_OWNER"
}],
"teamIds" : [ "5aeeed020bd6ef9d00033291", "5ac2aeadcabceef96172be31" ],
"username": "someone@example.com"
},
...
],
"totalCount" : 2
}
←  Get All Projects in an OrganizationCreate One Organization →