Get Users by Department

Overview

Use this API to retrieve users in a department. Only users that the logged in user can view are returned.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • The department must be the home department of the user, or a department in which the user is a foreign user.
  • If logged in user is a global user, one of the following is required:
    • User must have 'Administer' permission on the departments provided in the request.
    • User must have one of following privileges: 'View partition resources', 'Manage partition resources'.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

Department ID

Example: 999
query Parameters
$attribute
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

Available values: all, title, middleName, suffix, created, createdBy, authenticationType, manager, emailAddress, mobileNumber, externalId, custom.<name>

Examples:
$attribute=
Attributes 'created' and 'manager' are returned in the server response.
$attribute=created,manager
All the attributes are returned in the server response.
$attribute=all
$sort
string

Users returned in server response are sorted based on the attribute supplied under $sort.

Available values: id, firstName, lastName, loginId, custom.<name>

Examples:
$sort=
Response is sorted based on 'id' attribute.
$sort=id
Response is sorted based on 'firstName' attribute.
$sort=firstName
$order
string

Common query parameter $order.

Enum: "asc" "desc"
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 25

$rangestart
string

Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize.
Default value: 1

$rangesize
string

Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart.
Default value: 25

header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/department/{id}/users
Request samples
Response samples
application/json
    

  • This example demonstrates the following:
      

    • Search users in a department.
      • 

    • Representation of the summary attributes.
      • 

    • Sorting on ID.
      • 

    

    • 

  • GET /core/usermgr/v3/department/1003/users?$sort=id
    • 



{
  • "user": [
    ],
  • "paginationInfo": {
    }
}