Get user by ID

Description

Gets a user, specified by the user ID, from the system (available in versions 2020 SP3 and later).

You can also add an additional parameter ("include=user-role") to return user project and project role assignments. This parameter is available in LoadRunner Enterprise 2023 and later. The user role response is supported as JSON only; XML is not currently supported.

URL

/Admin/rest/v1/users/{userID}

/Admin/rest/v1/users/{userID}?include=user-roles

Remarks

None

HTTP Method

GET: Returns a user specified by ID.

Request

Headers:

Content-Type: application/xml

Accept: application/json, application/xml

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request Body:

None

Request Examples

Copy code

Get system user by ID

GET http://<LRE_Server>/Admin/rest/v1/users/2
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Copy code

Get system user by ID and include user role data

GET http://<LRE_Server>/Admin/rest/v1/users/2?include=user-roles
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes.

HTML Body:

See User response.

See Also

Add a user
Update a user
Delete a user
Assign project and role to user
Get all users
Get list of users by query