Versions Compared

Key

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

Learn how you can configure Access Token Business Definition that will dictate overall behavior of Access Tokens

What does this section cover?

Table of Contents
minLevel2

What are Access Token Definitions?

Access Token Definitions are used to control the creation of access tokens, by defining policies around the format of the access token user identifier and authentication code.

Creating, Editing & Deleting Validations & Restrictions

ActionValidationsRestrictions
GeneralN/A
  • Only one active access token definition can exist at any given time.
Create
  • Multiple access token definitions can exist in the system, but each one should have a unique name and alternative code.
N/A
EditN/AN/A
DeleteN/AN/A

Access Tokens Definition attributes 

Name

Description

NumberAn auto generated number that uniquely identifies the accounts receivable definitions
Name*The name of the definition
Alternative code*An alternative code for the definition. On creating a new definition it defaults to the first letter of each word included in the name (in Capitals), if nothing else is specified
DescriptionA description for the definition
StateThe state of the definition which can be active or inactive. Only one active definition can exist at any point
Identifier Settings: The settings related with the access token identifier
Minimum length

The minimum required length of the identifier

Minimum number of alphabetical characters (a-z)The minimum number of alphabetical characters (a-z) that should be included in the identifier
Minimum number of integers (0-9)The minimum number of integers (0-9) that should be included in the identifier
Minimum number of other (special) charactersThe minimum number of special characters that should be included in the identifier
Pass code Settings: The settings related with the access token pass code
Minimum lengthThe minimum required length of the pass code
Minimum number of alphabetical characters (a-z)The minimum number of alphabetical characters (a-z) that should be included in the pass code
Minimum number of integers (0-9)The minimum number of integers (0-9) that should be included in the pass code
Minimum number of other (special) charactersThe minimum number of special characters that should be included in the pass code
Automation Settings: The settings related with access token automations
Allow Creating Access Tokens with no identifier and pass codeIf enabled, then it will be possible to create access tokens without specifying an identifier and pass code
Allow Creating Access Tokens on Creating Rewards participantsIf enabled, then it will be possible to create access tokens directly through the process of creating a new rewards participant
Allow Creating Access Tokens on Creating Accounts Receivable

If enabled, then it will be possible to create access tokens directly through the process of creating a new accounts receivable

Reuse Accounts Receivable Access Tokens when possible

If enabled, then access tokens related with accounts receivable will also be associated with other entities which can automatically be related to access tokens, on relating those entities with accounts receivable. For example on creating a new rewards participant, related to an accounts receivable having an access token, then that access token will also be associated with the rewards participant as well.

Set Access Tokens as Not Effective on removing the last entity associationIf enabled, then an access token will be set a not effective if it was associated by one or more entities, and those associations were removed.

Defining your own Access Tokens Definition tailored to your company's needs

  1. Navigate to CONFIGURATION > FOUNDATION > ACCESS TOKENS > SET UP ACCESS TOKEN DEFINITIONS
  2. Either search for an existing one or from the Top Menu click on NEW
     
  3. MAIN INFORMATION

    1. Provide the required information

      1. Name

      2. Alternative Code

      3. Description

        Access token definitions - Main Information 

  4. SETTINGS

    1. IDENTIFIER

      1. Provide the required information

        1. Minimum  Length

        2. Minimum Number of Integers (0-9)

        3. Minimum Number of Alphabetical Characters (a-z)

        4. Minimum Number of Other Special Characters

          Access Token Definitions - Identifier

    2. PASSCODE

      1. Provide the required information

        1. Minimum  Length

        2. Minimum Number of Integers (0-9)

        3. Minimum Number of Alphabetical Characters (a-z)

        4. Minimum Number of Other Special Characters
          Access Token Definitions - Passcode

    3. AUTOMATION

      1. Provide the required information

        1. Allow Creating Access Tokens with No Identifier and Pass Code

        2. Allow Creating Access Tokens on Creating Rewards Participants

        3. Allow Creating Access Tokens on Creating Accounts Receivable

        4. Reuse Accounts Receivable Access Tokens when Possible

        5. Set Access Tokens as Not Effective on Removing the Last Entity Association

          Access Token Definitions - Automation

  5. LOG INFORMATION

  6. Include Page
    Log Information - Global
    Log Information - Global
  7. From the Top Menu click on Save

Deleting Access Tokens Definitions

Include Page
Deleting a record - Global
Deleting a record - Global

Changing the Life Cycle State of Access Tokens Definition

Include Page
Changing the Life Cycle State of a Definition - Global
Changing the Life Cycle State of a Definition - Global

Panel
namegrey

Related Areas

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

Panel
namegrey

Popular Labels

Popular Labels
spaceKeyV4Manual
styleheatmap