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

​
Overview

Allows the client to authenticate itself with the API, using the WWW-Authenticate Header available in the HTTP protocol. 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. Security Notice: Some WWW-Authentication mechanism send the password in clear text. While encryption is required, password is still unpacked by the remote endpoint, which may be a security consideration. Use the Login or QuickLogin resources to avoid this. The Javascript library uses the these resources instead of the WwwLogin alternative. But if a client is unable to generate cryptographic signatures as required by the specification, traditional WWW-Authentication mechanisms are also available.

​
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
​
expires
string<date-time>
required