Skip to Content
bpms.ai
ReferenceAuth

Log in

POST
/api/v1/auth/login

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.

Request Body

The credentials

application/json
  1. body
password*string

Password

Lengthlength <= 1024
strategy?string

Name of the authentication strategy

Lengthlength <= 1024
Default"native"
username*string

Username, case-insensitive

Lengthlength <= 1024

Response Body

The new session; it is not cached

application/json
  1. response
expiresAt?string

When the session ends

Formatdate-time
passwordChangeRequired?boolean

Whether the session may only change the password and log out

tenant?string

Public token of the user's tenant

token?string

Bearer token of the session; shown only here

Example Request
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"}