Search user based on user id
get
/iam/governance/selfservice/api/v1/users/{uuid}
Returns the user attributes of the target user ID. All the attributes of the user including the User Defined Fields (UDF's) are returned as part of the response payload. The response payload can be managed by specifying the attributes of interest in the "fields" query parameter.
Request
Supported Media Types
- application/json
Path Parameters
-
uuid: string
Target User ID
Query Parameters
-
fields(optional): string
Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "First Name, Middle Name, Last Name, Organization, Email, User Login, Employee Number, Department Number etc". The attributes of reference objects cannot be mentioned for example "Supervisor First Name", "Organization Name" etc.
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Examples
This retrieves a given user. The returned fields are filtered for Display Name, First Name, User Login, Department Number, and Middle Name. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password "https://pseudo.com/iam/governance/selfservice/api/v1/users/User1?fields=Display Name,First Name,User Login,Department Number,Middle Name"
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{
"fields": {
"Display Name": {
"base": "User1_FN User1_LN"
},
"Middle Name": null,
"usr_key": 1005,
"Department Number": null,
"User Login": "USER1",
"First Name": "User1_FN"
},
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/User1"
}
]
}