Jump to

• Request
• Response
• Examples

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

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : UserLinkDataInstances

Type: object

Show Source

• fields(optional): array fields
• links(optional): array links

{
    "properties":{
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

• Array of: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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