Skip to end of banner
Go to start of banner

authentication

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

POST authentication/token

This method returns an authentication token which can subsequently be used by all other Web API method to access the system.

Token expires every one (1) hour and a new one will need to be retrieved

 

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

 Example 1

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

 

 

  • No labels