| Table of Contents | ||
|---|---|---|
|
POST authentication/token
This method returns an authentication token which can subsequently be used by all other Web API method to access the system.
| Note |
|---|
Token expires every one (1) hour and a new one will need to be retrieved |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
username
(mandatory on conditions)
...
String
...
The username that should be used to login. Username is mandatory unless an access token identifier is specified
...
password
(mandatory on conditions)
...
String
...
The password that should be used to login. Password is mandatory unless an access token identifier is specified
...
(optional)
...
Access Token identifier
The identifier of the access token that should be used for authentication. Access token becomes mandatory if no username or password is specified. The allowed access token identifier fields are the following:
...
| Tip |
|---|
...
organisation
(mandatory)
...
String
...
The organization on which the user will login
...
unit
(optional)
...
String
...
The unit ID that the user will use during login. If not specified then the default unit for that user is used
Response Data
Name | Type | Description |
|---|---|---|
token | String | The authentication token which can be used to login |
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request:
Post Data:
Response:
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|