ClickHelp User Manual

Get login token

Returns a login token for the Power Reader. To learn more about the token login mechanism and how to use tokens, please refer to The Token Login Mechanism.

GET /users/{pr-login}/tokens?exp={exp-date}&muse={is-multiuse} 

Authentication

This request requires basic authentication.

Request Parameters

Path params
pr-login string
The login of the Power Reader to get the login token for. 
Query params
exp string
[optional] An ISO 8601 timestamp of the token expiration date. GMT timezone. The default value is 30 minutes from the current moment.
muse bool
[optional] Whether to consume the token on the first use. If true, the token can be used unlimited times until it hits the expiration date. false by default.

Samples

Request sample
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/users/pr1/tokens?exp=2077-69-42T02:35:00&muse=true'
Response body sample
JSON
{
"expirationDate": "2077-12-31T02:35:00Z",
"token": "SMxf5RlJ586y4iYWemQyECH51ueoOdBF",
"userName": "pr1",
"isMultiUse": true
}

Response fields

expirationDateAn ISO 8601 timestamp of the token expiration date. GMT timezone.
tokenThe generated login token.
userName
The login of the Power Reader.
isMultiUse
Whether the token can be used multiple times, i.e., not consumed on the first use.