Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier

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

Include Page

	V4:access_token_identifier
	V4:access_token_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

GET access_tokens/list

Tip
Available from CRM.COM R8.0.0

This method returns information related with multiple access tokens, which are related either with an accounts receivable or a rewards participant. Multiple access tokens are returned by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable related with the access token. The available accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant related with the access token. The available rewards participant identifier fields are the following:

Include Page

	V4:access_token_rewards_participants_identifier
	V4:access_token_rewards_participants_identifier

classification_identifier

(optional)

Access Token Classification Identifier

The identifier of the access token classification that retrieved access tokens should have. If specified then only access tokens having that classification will be retrieved. The allowed access token classification identifier fields are the following:

Include Page

	V4:access_token_classification_identifier
	V4:access_token_classification_identifier

Tip
Available from CRM.COM R10.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name	Type	Description
token	String	The token retrieved from the login method
number (mandatory)	Number	The number of access tokens that should be retrieved
life_cycle_state (optional)	String	The life cycle state of the access tokens that should be retrieved. The allowed options are EFFECTIVE or NOT_EFFECTIVE or PENDING_VERIFICATION
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

authentication_code

(optional)

String

The authentication code of the access token that will be created. If not specified then it will be generated automatically.

identifier

(mandatory on conditions)

String

The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code.

pass_code

(mandatory on conditions)

String

The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified.

accounts_receivable_identifier

(semi-optional on conditions)

Accounts Receivable Identifier

The identifier of the accounts receivable that will be related with the access token. The available accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

Tip
Available from CRM.COM R8.0.0 From release CRM.COM R14.0.0 onward the accounts_receivable_identifier* is semi-optional on conditions (optional in prior releases)*

This information is semi-optional on conditions, if the Access Token Pass Code is auto-generated

rewards_participant_identifier

(semi-optional on conditions)

Rewards Participant Identifier

The identifier of the rewards participant that will be related with the access token. The available rewards participant identifier fields are the following:

Include Page

	V4:access_token_rewards_participants_identifier
	V4:access_token_rewards_participants_identifier

Note that if an accounts receivable is also specified, then the rewards participant should be owned by that accounts receivable

Tip
Available from CRM.COM R8.0.0 From release CRM.COM R14.0.0 onward the rewards_participant_identifier is semi-optional on conditions (optional in prior releases)

This information is semi-optional on conditions, if the Access Token Pass Code is auto-generated

classification_identifier

(optional)

Access Token Classification Identifier

The identifier of the access token classification that will be related with the access token. The allowed access token classification identifier fields are the following:

Include Page

	V4:access_token_classification_identifier
	V4:access_token_classification_identifier

Tip
Available from CRM.COM R10.0.0

udf_string_1

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_2

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_3

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_4

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_5

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_6

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_7

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_8

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_float_1

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_float_2

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_float_3

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_float_4

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_date_1

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

udf_date_2

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

udf_date_3

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

udf_date_4

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip
Available from CRM.COM R10.0.0

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
It is mandatory to specify one of the semi-optional on conditions parameters, when these conditions are met. At least one of those parameters needs to be specified.

...

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier

The identifier of the access token that should be updated. The allowed access token identifier fields are the following:

Include Page

	V4:access_token_identifier
	V4:access_token_identifier

authentication_code

(optional)

String

The authentication code of the access token that will be updated. Is specified as null then the authentication code will be regenerated automatically

identifier

(mandatory on conditions)

String

The identifier of the access token that will be update. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code.

pass_code

(mandatory on conditions)

String

The pass code of the access token that will be updated. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified.

udf_string_1

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_2

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_3

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_4

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_5

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_6

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_7

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_8

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_float_1

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_float_2

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_float_3

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_float_4

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R10.1.0

udf_date_1

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

udf_date_2

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

udf_date_3

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

udf_date_4

(optional)

Date

User Defined Field of type Date

Tip
Available from CRM.COM R10.1.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip
Available from CRM.COM R10.0.0

Restrictions

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

...

POST access_tokens/verify

Tip
Available from CRM.COM R9.0.0

This method verifies access tokens which are in Pending Verification life cycle state. A single access token can be verified by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier

The identifier of the access token that should be verified. The allowed access token identifier fields are the following:

Include Page

	V4:access_token_identifier
	V4:access_token_identifier

verification_code

(mandatory)

String

The verification code which is needed in order to verify the access token

pass_code

(optional)

String

The pass code of the access token that will be provided during verification

Tip
Available from CRM.COM R14.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip
Available from CRM.COM R10.0.0

Restrictions

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

...

POST access_tokens/reset_pass_code

Tip
Available from CRM.COM R9.0.0

This method resets an access token pass code to a random 6 digit number, by providing the access token authentication code or identifier. This method can be applied only on effective access tokens. A single access token can be update by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

String

The identifier of the access token

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip
Available from CRM.COM R10.0.0

Restrictions

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

...

POST access_tokens/reset_verification_code

Tip
Available from CRM.COM R12.0.0

This method resets an access token verification code, by providing the access token authentication code or identifier. This method can be applied only on Pending Verification access tokens. A single access token can be update by each call.

...

Name	Type	Description
token	String	The token retrieved from the login method
authentication_code (semi-optional)	String	The authentication code of the access token
identifier (semi-optional)	String	The identifier of the access token.
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "token":"{{token}}",
  "identifier":"36"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "data": {
    "authentication_code": "ET",
    "number": "AT0000000136",
    "identifier": "36",
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-10-05T13:19:56",
      "updated_date": "2017-02-13T14:51:08",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "username": "MPAdministrator"
      }
    },
    "id": "5D79DBBA75C245F9A63C9FA6E084D250",
    "life_cycle_state": "PENDING_VERIFICATION",
    "verification_code": "2264365"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST access_tokens/generate_otp

Tip
Available from CRM.COM R13.0.0

This method generates a one-time password (OTP) for an access token, by providing the access token identifier. A single access token otp can be generated by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token identifier

The identifier of the access token for which a one-time password will be generated. The allowed access token identifier fields are the following:

Include Page

	V4:access_token_identifier
	V4:access_token_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Response Data

Include Page

	V4:access_token_otp_complete
	V4:access_token_otp_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "token":"{{token}}",
	"access_token_identifier":{"authentication_code":"117"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "data": {
    "number": "AT0000000758",
    "one_time_password": "073482",
    "id": "5E94D0D8D3C84ED6A07A3F5E91CFC948",
    "expiration_date": "2017-05-22T13:48:07"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Versions Compared

Old Version 49

New Version 50

Key

GET access_tokens/list

Restrictions

Restrictions

POST access_tokens/verify

Restrictions

POST access_tokens/reset_pass_code

Restrictions

POST access_tokens/reset_verification_code

POST access_tokens/generate_otp

Resource URL

Parameters

Response Data

Examples

Page Comparison

Versions Compared

Old Version 49

New Version 50

Key

GET access_tokens/list

Restrictions

Restrictions

POST access_tokens/verify

Restrictions

POST access_tokens/reset_pass_code

Restrictions

POST access_tokens/reset_verification_code

POST access_tokens/generate_otp

Resource URL

Parameters

Response Data

Examples