Get User by IDs

Overview

Use this API to retrieve one or more users identified by user IDs. Only department users can be retrieved using this API. To provide multiple IDs, a comma separated string must be used in request URI. A maximum of 75 IDs is allowed per request. Neither pagination nor range query parameters are supported by this API.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • The user must have 'view permission' on the users provided in the request.
  • If logged in user is a global user, one of the following is required:
    • User must have 'Administer' permission on the departments of the users 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
ids
required
string <= 20000 characters

Pass one id or comma sperated list of id(s).

Examples:
Providing single ID.
1001
Providing multiple IDs.
1001,1002
query Parameters
$attribute
string

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

Available values

  • If single user ID provided: all, title, middleName, suffix, created, createdBy, authenticationType, manager, emailAddress, mobileNumber, directReports, groups, languages, externalId, custom.<name>
  • If multiple user IDs provided: all, title, middleName, suffix, created, createdBy, authenticationType, manager, emailAddress, mobileNumber, externalId, custom.<name>
Examples:
$attribute=
Attributes 'created' and 'manager' are returned in 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"
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/users/{ids}
Request samples
Response samples
application/json
    

  • This example demonstrates the following:
      

    • Retrieving the summary attributes of a single user.
      • 

    

    • 

  • GET /core/usermgr/v3/users/1049
    • 



{
  • "user": [
    ]
}