Navigation
You were redirected from a different version of the documentation. Click here to go back.

Get All Users in a Group

Base URL: {opsManagerHost}:{port}

Syntax

GET /api/public/v1.0/groups/{GROUP-ID}/users

Request Parameters

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required. The unique identifier for the group.

Request Query Parameters

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

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Display response in human-readable format. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Name Type Description
totalCount integer The number of users in this Ops Manager group.
results document array Array of user documents.
results.id string The unique identifier for the user.
results.username string The Ops Manager username.
results.emailAddress string The email address for the Ops Manager user.
results.firstName string The first name displayed for the returned Ops Manager user.
results.lastName string The last name displayed for the returned Ops Manager user.
results.roles document array The roles to which this user is assigned.
results.roles.groupId string The unique identifier for the group role.
results.roles.roleName string The display name for the user role.
results.links string array See Response Links.
links string array See Response Links.

Response Links

Relation Description
self Me
http://{opsManagerHost}:{port}/users All users in the group.
http://{opsManagerHost}:{port}/whitelist The user’s whitelist.

Examples

Example Request

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{GROUP-ID}/users?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {DATE-IN-UNIX-FORMAT}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{NONCE}", algorithm=MD5, op="auth", stale=false
Content-Length: {REQUEST-LENGTH}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {DATE-IN-UNIX-FORMAT}
Connection: keep-alive
Content-Length: {REQUEST-LENGTH}

Response Body

{
  "links" : [ {
    "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{GROUP-ID}/ users?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "emailAddress" : "joe.bloggs@example.com",
    "firstName" : "Joe",
    "id" : "{USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "http://{opsManagerHost}:{port}/api/atlas/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "http://{opsManagerHost}:{port}/api/atlas/v1.0/users/{USER-ID}/whitelist",
      "rel" : "http://mms.mongodb.com/whitelist"
    } ],
    "roles" : [ {
      "groupId" : "{GROUP-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{OTHER-GROUP-ID}",
      "roleName" : "GROUP_OWNER"
    }
    ...
    ],
    "username" : "joe.bloggs"
  }, {
    "emailAddress" : "jim.bloggs@example.com",
    "firstName" : "Jim",
    "id" : "{OTHER-USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "http://{opsManagerHost}:{port}/api/atlas/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "http://{opsManagerHost}:{port}/api/atlas/v1.0/users/{OTHER-USER-ID}/whitelist",
      "rel" : "http://mms.mongodb.com/whitelist"
    } ],
    "roles" : [ {
      "roleName" : "GLOBAL_READ_ONLY"
    }, {
      "groupId" : "{GROUP-ID}",
      "roleName" : "GROUP_OWNER"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}