ClickHelp User Manual

[API] Get Login Token

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

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

Authentication

This request requires basic authentication.

Path params

user-login	string	The login of the user 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.

Request sample

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/users/user1/tokens?exp=2077-07-07T02:35:00&muse=true'

Response body sample

JSON

{
    "expirationDate": "2077-07-07T02:35:00Z",
    "token": "SMxf5RlJ586y4iYWemQyECH51ueoOdBF",
    "userName": "user1",
    "isMultiUse": true
}

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