/Account/Refresh
Allows the client to refresh a session token, maintaining the current login, regardless of method used in the original login.
If authentication succeeds, a new JSON Web Token (or JWT) is returned to the client. This replaces the token provided in the first login request or subsequent refresh requests. The token also needs to be refreshed before it expires.
If failing to refresh a token, or if the token expires, a new login must be performed. This can be done using either of the Login or WwwLogin resources.
JSON
- Request
{ "seconds":Required(Int(0 < PSeconds <= 3600)) }- Response (if successful)
{ "jwt":Required(Str(PJwt)), "expires":Required(DateTime(PExpires)) }
XML
- Request
<Refresh xmlns="https://waher.se/Schema/BrokerAgent.xsd" seconds=(Required(Int(0 < PSeconds <= 3600))) />- Response (if successful)
<LoggedIn xmlns="https://waher.se/Schema/BrokerAgent.xsd" jwt=(Required(Str(PJwt))) expires=(Required(DateTime(PExpires))) />
Input Parameters
| Parameter | Description |
|---|---|
PSeconds |
Requested number of seconds before the JWT token that will be issued expires. |
Response Parameters
| Parameter | Description |
|---|---|
PJwt |
A token representing the login to the account. This token is seant as a Bearer token in requests requiring authentication. |
PExpires |
When the JWT token expires. The token needs to be renewed before this token expires, if the client wishes to maintain the connection. After the token expires, the client needs to login again. |
Javascript Library
Use the following asynchronous method in the Javascript Library, to call this resource.
Note: The library calls it automatically to maintain the token while the session is active.
var Response = await AgentAPI.Account.Refresh(Seconds);
Note: If the refreshing of the token is successful, the API library will maintain the new token, and make sure to refresh it when needed.