A collection of users
Name | Type | Description |
---|---|---|
users | array of User | Collection of user. |
total | number | Only applies in the response to searching for users and setting the includeTotal parameter to true in the
request. Represents the total number of users that matched the search, which may be different from the number of users
actually returned.
|
Example
{ "users" : [ { "links" : [ { "rel" : "groups", "href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/groups" }, { "rel" : "...", "href" : "..." } ], "guid" : "6dd3a8e2-3f24-48c6-961a-949794f4b554", "ecoid" : "AnTPNzecbqn6j7+aIfV5jdc=", "directoryId" : "e7aad64542784faeab305304abea36fa", "company" : "BlackBerry Limited", "title" : "Associate", "department" : "Sales", "officePhoneNumber" : "(519) 555-0100", "homePhoneNumber" : "(519) 555-0101", "mobilePhoneNumber" : "(519) 555-0102", "streetAddress" : "2240 University Avenue", "poBox" : "555", "city" : "Waterloo", "state" : "Ontario", "postalCode" : "N2K 0A9", "country" : "Canada", "admin" : true, "created" : "2018-02-01T09:46:08.514Z", "username" : "pmorley", "displayName" : "Paul Morley", "firstName" : "Paul", "lastName" : "Morley", "emailAddress" : "pmorley@example.com" }, { "links" : [ { "rel" : "...", "href" : "..." }, { "rel" : "...", "href" : "..." } ], "guid" : "2d2d3a7f-076d-46f9-8c25-56cb8eba2800", "ecoid" : "AgToYDulBpU8qcaAfj8YZQw=", "directoryId" : "...", "company" : "...", "title" : "...", "department" : "...", "officePhoneNumber" : "...", "homePhoneNumber" : "...", "mobilePhoneNumber" : "...", "streetAddress" : "...", "poBox" : "...", "city" : "...", "state" : "...", "postalCode" : "...", "country" : "...", "admin" : false, "created" : "2019-01-14T16:40:03.54Z", "username" : "jromphf", "displayName" : "Jake Romphf", "firstName" : "Jake", "lastName" : "Romphf", "emailAddress" : "jromphf@example.com" } ], "total" : 12345 }