Get 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
Path Parameters
Query Parameters
  • 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.
Back to Top

Response

Supported Media Types

200 Response

Successful
Headers
Body ()
Root Schema : UserLinkDataInstances
Type: object
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : Fields
Type: object
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error
Back to Top

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/23?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.

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/users/23"
        }
    ],
    "fields": [
        {
            "name": "Display Name",
            "value": {
                "base": "Beatrix Kiddo"
            }
        },
        {
            "name": "First Name",
            "value": "Beatrix"
        },
        {
            "name": "usr_key",
            "value": 23
        },
        {
            "name": "User Login",
            "value": "BKIDDO"
        }
    ]
}
Back to Top