Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel2

...

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

...

Expand
titleExample 1

HTTP Method: POST

 Request:

 

Post Data:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "username": "mpadministrator",
    "password": "1234",
    "organisation": "CRMDEMO",
    "unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status": {
        "code": "OK",
        "message": null,
        "description": null
    },
    "data": {
        "token": "4AD9C84FA60F9FE407140E20F707726A"
    }
}

POST authentication/token/release

Tip

Available from CRM.COM R10.0.0

This method releases an authentication token in order to make it not usable by any other subsequent Web API calls

Note

Token expires every one (1) hour and a new one will need to be retrieved. It is recommended to release tokens if there are not needed any more

Resource URL

Parameters

Name

Type

Description

token

(mandatory)

String

The authentication token which will be released

Response Data

Not applicable

Examples

Expand
titleExample 1

HTTP Method: POST

 Request:

 

Post Data:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue