POST access_tokens/reset_pass_code

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R16.12.0, CRM.COM R17.10.0 & CRM.COM R18.0.0

This method resets an access token pass code to a random 6 alphanumeric characters, 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. From CRM.COM R13.1.0 this method will reset the access token pass code to one that meets the configured Access Token Definition or Classification pass code settings

Resource URL

Parameters

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

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.

Response Data

Name

Type

Description

id

String

The ID of the retrieved access token

number

String

The number of the retrieved access token

life_cycle_stateString

The state of the retrieved access token which can be one of the following:

EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION

authentication_code

StringThe authentication code of the retrieved access token
identifierStringThe identifier of the retrieved access token
random_pass_codeStringThe pass code that was randomly generated (not encrypted)

log_information

Log Information Object

The log information related with the retrieved access token

Referred Objects Response Data

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

Examples

 Example 1

HTTP Method: POST


Request


Body

{
  "token":"7031041502C7442CA01FA677D0CCDB4B",
  "authentication_code":"7"
}


Response

{
 "status": {
 "message": "",
 "description": "",
 "code": "OK"
 },
 "data": {
 "log_information": {
 "updated_date": "2015-12-28T15:22:07",
 "created_date": "2015-11-26T19:26:43",
 "created_by_unit": {
 "id": "48305F8849E3C18B227C5BE3A27BA6DF",
 "name": "Admin Unit",
 "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
 "alternative_code": "MG"
 },
 "updated_by_unit": {
 "community_name": "Internal Community",
 "id": "48305F8849E3C18B227C5BE3A27BA6DF",
 "name": "Admin Unit",
 "group_name": "Main Group",
 "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
 "alternative_code": "MG"
 },
 "created_by_user": {
 "person_name": "MPAdministrator",
 "username": "MPAdministrator",
 "id": "1"
 },
 "updated_by_user": {
 "person_name": "Marios Lannister",
 "username": "MPAdministrator",
 "id": "1"
 }
 },
 "authentication_code": "7",
 "life_cycle_state": "EFFECTIVE",
 "identifier": "lpapap@gmail.com",
 "number": "ACT0000000177",
 "id": "E8D62A98078A44F79646E4CB4C7DAB19",
 "random_pass_code": "967412"
 }
}