POST tucano/subscriber/authenticate

Available from CRM.COM R11.0.0

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(semi-optional)

Access Token Identifier

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:

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

String

The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code

pass_code

(mandatory on conditions)

String

The pass code of the access token, which is applicable and mandatory if the identifier is specified

Deprecated from CRM.COM R18.0.0

customer_identification_medium_identifier

(semi-optional)

Customer Identification Medium Identifier

The identifier of the customer identification medium related with the subscription that should be returned as a result. The allowed customer identification medium identifier fields are the following

Name

Type

Description

name

(semi-optional)

String

The name of the customer identification medium

value

(semi-optional)

String

The value of the customer identification medium

Available from CRM.COM R18.0.0

installed_item_identifier

(semi-optional)

Installed Item Identifier

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

subscription_identifier

(semi-optional)

Subscription Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

subscription_type_identifier

(optional)

Subscription Type Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription type

name

(semi-optional)

String

The name of the subscription type

alternative_code

(semi-optional)

String

The alternative code of the subscription type

This parameter is applicable only if the access token identifier is specified.

Available from CRM.COM R12.4.0

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

String

The ID of the subscription as defined in CRM.COM

jwt

Json 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

Example 1

HTTP Method: POST

Request:

Body:

{
    "token":"35108255345D4F98ABFD7810A08E432F",
    "subscription_identifier":{"number":"S0000000329"}
}

Response:

    {
        "data":
        {
            "subscription_id": "75E3E50139F24DC3A6C9AA0C026D0292",
            "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzgyNTE5MzEsImlhdCI6MTQ3ODI1MTYzMSwidXNlcm5hbWUiOiJTMDAwMDAwMDMyOSJ9.FgRjJ6vuhRTP_0A1yFSxaRcaIugkJK5GyHbt1rRGxA0"
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }