ClickHelp User Manual

Get power reader profile

Returns information on the Power Reader.

GET users/{pr-login}

Authentication

This request requires basic authentication.

Request Parameters

Path params
pr-login string
The login of the Power Reader to get information about.

Samples

Request sample
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/users/pr1'
Response body sample
JSON
{
"userInfo": {
"about": null,
"authorUiFourLetterCode": "en-US",
"avatarImageUrl": null,
"cultureInfoId": "en-US",
"email": "power-reader@email.com",
"firstName": "Power",
"isAutoDetectCultureInfo": true,
"isAutoDetectTimeZone": true,
"lastActivityDate": null,
"lastName": "Reader",
"middleName": "",
"timeZoneId": "UTC"
},
"userName": "pr1",
"userRole": null,
"isEnabled": true
}

Response fields

userInfoAn object containing basic profile information.
    about
Information the user specified in the About box.
    avatarImageUrl
URL of the image used as an avatar.
    cultureInfoId
A four-letter language code of the Power Reader's culture.
    email
Email of the Power Reader.
    firstName
First name of the Power Reader.
    isAutoDetectCultureInfo
Whether the culture is automatically detected. false if the culture is explicitly set by the user.
    isAutoDetectTimeZone
Whether the time zone is set to be automatically detected.
    lastActivityDate
An ISO 8601 timestamp of the Power Reader's last activity date. GMT timezone.
    lastName
Last name of the Power Reader.
    middleName
The middle name of the Power Reader.
    timeZoneId
An ID of the time zone the user specified.
userNameThe login of the Power Reader.
userRole
Comma-separated list of Power Reader roles assigned to this user.
isEnabled
Whether the account is enabled or not.