This method returns an authentication token which can subsequently be used by all other Web API methods to access the system.
Token expires after one hour of idle time (i.e. one hour of not using the token)
From CRM.COM R12.0.0 onwards: Token expires after two hours, regardless of if the token is used or not, and a new one should be retrieved. The token is returned in JWT structure and the length of the token will be more that 32 characters
Resource URL
Parameters
Name | Type | Description |
|---|---|---|
username (mandatory) | String | The username that should be used to login. |
password (mandatory) | String | The password that should be used to login. |
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
HTTP Method: POST
Request
Post Data
{
"username": "mpadministrator",
"password": "1234",
"organisation": "CRMDEMO",
"unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}
Response
{
"status": {
"code": "OK",
"message": null,
"description": null
},
"data": {
"token": "4AD9C84FA60F9FE407140E20F707726A"
}
}