Versions Compared

Key

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

Find out how to create a new Access Tokens

What does this section cover?

Table of Contents
minLevel2

Navigating to Access Tokens

Info

FOUNDATION > ACCESS TOKENS > MANAGE ACCESS TOKENS

Explaining Access Tokens Fields

Using Access Tokens

Use Access Tokens module to create or edit existing Access Tokens which will be used to identify and authenticate your customers in CRM.COM.


Navigate to Access Tokens and explore existing records via the Summary page. Click on the link (name or number) of the record of your interest to enter the Data Entry Page and have a better look of the available information. 
Use the Actions Menu to create a new (NEW) Access Token or modify (EDIT). You are not allowed to delete an access token.
Use the BACK link to go back to the summary page and CANCEL to cancel any unwanted changes made to the Access Token. Click on ACTIONS to see the available actions to be performed on Access Tokens and visit the Advanced Section for a thorough description of each of the actions.

Check out the attributes table below for a thorough explanation of the information kept for Access Tokens and  check validations&restrictions table to find out validations and restrictions applicable when working with Access Tokens

ACCESS TOKENSImage Added

Anchor
validations
validations
 Validations & Restrictions

Action
Restrictions
Create
Save
Edit
  • Access Token cannot be set as Not Effective if it is related to any entity of Rewards Participants which is Not Terminated itself
  • Rewards Participant or Accounts Receivable cannot be removed/updated once set (via Access Token Screens)
  • Mandatory Fields as defined in the
Delete
  • You are not allowed to delete Access Tokens

Anchor
attributes
attributes
Access Tokens Attributes

LOG INFORMATION

The following information is automatically set by the system on saving the Access Tokens

Include PageLog Information - GlobalLog Information - Global

Includes the standard log information

Red R9 The following information is also included:Verified On: The date that

Name

Description

NumberAn auto generated number that uniquely identifies each access token
Authentication Code*

The authentication code that will be submitted while accessing the system in order to identify the access token that should be used for authentication and identification purposes.
This information is set to read only if the automatic creation method of the authentication code is not equal to none in Access Token Definitions.
Format Validation is applicable if defined in:

  • the selected Access Token Classification -
    Status
    colourGreen
    titleAvailable from CRM.COM R10.0.0

    Or if classification is not defined or does not exist
  • the active Access Token Definitions
.
  •  


Visit Applying Access Token Definition Settings on Access Tokens to see what validations will be performed on the Authentication Code, on saving an Access Token

Identifier

The identifier of the user which is trying to access the system.
Identifier can be mandatory if it is set as mandatory in Access Token Definitions.
This information is set to read only if the automatic creation method of the identifier is not equal to none in Access Token Definitions.

Format Validation is applicable if defined in:

  • the selected Access Token
Definitions.
  • Classification -
    Status
    colourGreen
    titleAvailable from CRM.COM R10.0.0

    Or if classification is not defined or does not exist
  • the active Access Token Definitions 


Visit Applying Access Token Definition Settings on Access Tokens to see what validations will be performed on the Identifier, on saving an Access Token

Pass CodeThe pass code which is required in order to authenticate the user while accessing the system.
Pass code can be mandatory
if it was set as mandatory in Access Token Definitions .
This information is set to read only if the automatic creation method of the pass code is not equal to none in Access Token Definitions.

Format Validation is applicable if defined in:

  • the selected Access Token
Definitions.
  • Classification -
    Status
    colourGreen
    titleAvailable from CRM.COM R10.0.0

    Or if classification is not defined or does not exist
  • the active Access Token Definitions 


Visit Applying Access Token Definition Settings on Access Tokens to see what validations will be performed on the Pass Code , on saving an Access Token
Life Cycle StateThe life cycle state of the access token which can be Effective or Not Effective. Only Effective access tokens can be used to access the system
Accounts Receivable

The accounts receivable which is linked with the specific access token. This information is editable only on creating the access token. Relation between Accounts Receivable and the Access Token can be cancelled by removing the Access Token from the Accounts receivable screen.

Visit Applying Access Token Definition Settings on Access Tokens to find settings related to Accounts Receivable and Access Tokens

Rewards ParticipantThe rewards participant which is linked with the specific access token. This information is editable only on creating the access token. If an accounts receivable is also specified, then the rewards participants that can be selected should also be related with that accounts receivable.
Relation between Rewards Participant  and the Access Token can be cancelled by removing the Access Token from the Accounts receivable screen

Visit Applying Access Token Definition Settings on Access Tokens to find settings related to Rewards Participants and Access Tokens

Log Information

Classifications

Status
colour

Green
titleAvailable from CRM.COM

R10.0.0

The classification of the access token

was verified

.

  • Verified By: The user that verified the access token
  • Verification Code: The code used to verify the access token
  •  

    Creating & Saving, Validations & Restrictions

    Action
    Restrictions
    Create
    Save

    Creating an Access Token

  • From the top menu click on NEW to open the Access Tokens data entry page
    ACCESS TOKENImage Removed
  • MAIN INFORMATION

    1. Provide the following information:

      1. Authentication Code: Hover your mouse over the Tool Tip to see what are the formatting rules defined in the Access Token Definitions and if required provide an Authentication Code
      2. Identifier: Hover your mouse over the Tool Tip to see what are the formatting rules defined in the Access Token Definitions and if required provide an Identifier
      3. Pass Code: Hover your mouse over the Tool Tip to see what are the formatting rules defined in the Access Token Definitions and if required provide a Pass Code
      4. Rewards Participants: Search and add a Rewards Participant if you want to relate the access token to one, by using quick search or search modal
      5. Accounts Receivable: Search and add an Accounts Receivable if you want to relate the access token to one, by using quick search or search modal
    2. View information regarding the following:
      1. Life Cycle State
  • From the Action Menu click on SAVE
  • NOTE: The access token classification is editable only on creating an access token. The classification of the access token cannot be changed after creating the access token

    Log Information

    Log Information

    Includes the standard log information

    Status
    colourRed
    titleAvailable from CRM.COM R9
    The following information is also included:

    • Verified On: The date that the access token was verified
    • Verified By: The user that verified the access token
    • Verification Code: The code used to verify the access token

    System Processing

    • If no authentication code was defined, once the access token is saved then it will be automatically created.
    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalseexcerpttrue
    labelsaccess-tokens-basics-r7,access-tokens-admin-r7

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    excerpttrue
    labelsglobal