Documentation: Log in using the API key
Login using API key
Create API key
First you must set-up an API key. For this, please log in to the Flowy instance to which you want to log using that key. Go to the administrative Front-end, open the desired user and create an API key by clicking on the according button. Please save this API key in a password safe as its only displayed once.
Please ensure that the user login by api key process module is installed on this Flowy instance.
Log in using the API key
In order to log in, you must implement an POST request to <restTriggerURL>/login.
Content-Type: application/json
{"email":"youraddress@example.com","apiKey":"11111111-1111-1111-1111-111111111111"}
The server will respond in a positive case with:
{"status":"SUCCESS","statusCode":"OK",
"statusText":"OK",
"data":{"eventId":123456,"body":{"token":"22222222-2222-2222-2222-222222222222"}}}
You can trigger now further Flowy REST triggers which require authentication; please make sure to send along the received token in the format x-auth-token: 22222222-2222-2222-2222-22222222222222222222-2222-2222-2222-222222222222 as request header.
Login using Basic Authentication
It is possible to access REST triggers using Basic authentication. In this case, the according setting must be enabled on the REST trigger as this is disabled by default.
In this case, the combination of email address and API key must be used.
This possibility is provided for backward compatibility and its usage is not recommended.
Log in using email and password
This functionality is provided to enable the implementation of processes that utilize Flowy's built-in user management.
In order to log in, you must implement an POST request to <restTriggerURL>/login-by-password and provide the email and password value along.
If the login is successful, the token will be returned and can be used for further requests.
Accessing the user ID within a process
If the requesting user is authenticated, Flowy will fill in the user ID into the following field:
$.restRequest.userId
The User step provides the necessary functions to i.e. check the associated roles.