Versions Compared

Key

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

Available from CRM.COM R11.0.0

 

Table of Contents
maxLevel2

POST tucano/subscriber/authenticate

This method authenticates a subscriber against CRM.COM provisoned by AlphaNetworks Tucano system and returns a Json Web Token to indicate that the subscriber was authenticated succesfully. 

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

access_token_identifier

(semi-optional)

...

The identifier of the access token related with the subscription that should be returned as a result. The allowed access token identifier fields are the following:

...

installed_item_identifier

(semi-optional)

...

The identifier of the installed item related with the subscription that should be returned as a result. The allowed installed item identifier fields are the following:

...

subscription_identifier

(semi-optional)

...

The identifier of the subscription that should be returned as a result. The allowed subscription identifier fields are the following:

...

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

subscription_id

StringThe ID of the subscription as defined in CRM.COM
jwtJson Web Token

The Json Web Token used for authentication purposes.

The JWT header includes the following attributes: alg,typ

The JWT payload includes the following attributes: exp, userid, apip

Examples

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"35108255345D4F98ABFD7810A08E432F",
    "subscription_identifier":{"number":"S0000000329"}
} 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{ "data": { "subscription_id": "75E3E50139F24DC3A6C9AA0C026D0292", "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzgyNTE5MzEsImlhdCI6MTQ3ODI1MTYzMSwidXNlcm5hbWUiOiJTMDAwMDAwMDMyOSJ9.FgRjJ6vuhRTP_0A1yFSxaRcaIugkJK5GyHbt1rRGxA0" }, "status": { "code": "OK", "description": "", "message": "" } }  Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue