Table of Contents
  1. JSON
  2. XML
  3. Response Parameters
  4. Javascript Library

/Account/GetSessionToken

Allows the client to get session information about a newly created account, created using a web form, without having to provide user credentials again.

JSON

Request
{
}
Response (if successful)
{
	"AccountCreated":
	{
		"created": Required(DateTime(PCreated)),
		"enabled": Required(Bool(PEnabled)),
		"canRelay": Required(Bool(PCanRelay)),
		"jwt": Required(Str(PJwt)),
		"expires": Required(DateTime(PExpires))
	},
	"seconds": Required(Int(0 < PSeconds <= 3600))
}

XML

Request
<GetSessionToken xmlns="https://waher.se/Schema/BrokerAgent.xsd" />
Response (if successful)
<SessionToken xmlns="https://waher.se/Schema/BrokerAgent.xsd"
              seconds=(Required(Int(0 < PSeconds <= 3600)))>
	<AccountCreated xmlns="https://waher.se/Schema/BrokerAgent.xsd"
	                created=(Required(DateTime(PCreated)))
	                enabled=(Required(Bool(PEnabled)))
	                canRelay=(Required(Bool(PCanRelay)))
	                jwt=(Required(Str(PJwt)))
	                expires=(Required(DateTime(PExpires))) />
</SessionToken>

Response Parameters

Parameter Description
PSeconds Requested number of seconds before the JWT token that will be issued expires.
PCreated When account was created (server timestamp).
PEnabled If account is enabled or not. When creating an account, it’s disabled by default, until the e-mail address has been validated.
PCanRelay If account can be used to relay e-mails.
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: Calling this function will also initiate automatic session refresh by the library.

var Response = await AgentAPI.Account.GetSessionToken();
Test

Request Payload:

Response Payload: