API Authorization calls
The authorization controller is used to login to the API, in addition user management.
When a login call is completed, the API will return a bearer token which should be used in the auth header of all future calls. This token is set to expire 10 minutes after its generation.
A refresh token is also included in the login response, and this is used in the body of the refresh call to get new tokens with refreshed expiry times. Ensure a refresh call is made prior to any given bearer token's expiry to avoid having to login again.
Ok response
Username
Refresh token
Ok response
API token
API refresh token
Username
Password
Ok response
API token
API refresh token
Default Response
Result
Username
Ok response
User ID
User ID
New password
Ok response
Result
User ID
Role profile
Has admin permission
Has flows editing permission
Has configuration editing permission
Has subscription permission
Has write permission
Has read permission
Username
Password
Role profile
Has admin permission
Has flows editing permission
Has configuration editing permission
Has subscription permission
Has write permission
Has read permission
Ok response
User ID
User ID
Role profile
Has admin permission
Has flows editing permission
Has configuration editing permission
Has subscription permission
Has write permission
Has read permission
Ok response
Role profile
Has admin permission
Has flows editing permission
Has configuration editing permission
Has subscription permission
Has write permission
Has read permission