ReferenceAuth
Log in
POST
Proves the credentials with the chosen strategy and opens a session bound to the REST API. Attempts are limited per client address and per account; every failure of the credentials, the user, or the strategy answers the same problem.
The credentials
application/json- body
password*stringPassword
Length
length <= 1024strategy?stringName of the authentication strategy
Length
length <= 1024Default
"native"username*stringUsername, case-insensitive
Length
length <= 1024The new session; it is not cached
application/json- response
expiresAt?stringWhen the session ends
Format
date-timepasswordChangeRequired?booleanWhether the session may only change the password and log out
tenant?stringPublic token of the user's tenant
token?stringBearer token of the session; shown only here
curl -X POST 'https://bpms.bpms.work/api/v1/auth/login' \ -H 'Content-Type: application/json' \ -d '{ "password": "string", "username": "string"}'Example Response
{ "expiresAt": "2019-08-24T14:15:22Z", "passwordChangeRequired": true, "tenant": "string", "token": "string"}