Skip to main content
POST
/
Agent
/
Account
/
QuickLogin
Quick Login
curl --request POST \
  --url https://{host}/Agent/Account/QuickLogin \
  --header 'Content-Type: application/json' \
  --data '{
  "seconds": 123
}'
{
  "jwt": "<string>",
  "userName": "<string>",
  "expires": "2023-11-07T05:31:56Z"
}

​
Overview

Allows the client to authenticate itself with the API using a Quick-Login. performed in the current HTTP Session. This method is an alternative to the Login and WwwLogin resources. Note: To be able to access the current session, cookies must be enabled. Note 2: Community Login is demonstrated in the link above, as it uses Quick-Login in session mode. API documentation for Quick-Login can be found here: QuickLogin API Documentation. You need to have the Community Package installed for the Community Login to be available. Note 3: It is assumed the Agent API account resides on the same broker. The Agent API is an HTTP REST API for using an XMPP account on an XMPP broker. Once you have made a Quick-Login in a broker, you can use the RemoteQuickLogin resource to perform session logins on other brokers using the QuickLogin on the current broker, providing the JWT token obtained from the current broker. If authentication succeeds, a JSON Web Token (or JWT) is returned to the client. This token can be used as a Bearer token in subsequent calls to the API. It needs to be refreshed before it expires.

​
Authentication

No authentication required.

​
Notes

This endpoint uses the request schema notation described in Pattern matching.

Body

application/json
​
seconds
integer
required
Required range: x <= 3600

Response

200 - application/json

Success

​
jwt
string
required
​
userName
string
required
​
expires
string<date-time>
required