Category Component 26.1
Category Component Help

# Create User PIN Codes

You can create user PIN codes to use for authentication in addition to passwords. The Community component can lock users out if they fail to authenticate using the PIN code.

To configure the Community component to use PIN codes

1. Open the Community component configuration file in a text editor.

2. Find the `[User]` section, or create one if it does not exist.

3. Set the `PincodeLength` parameter to the length of PIN code that you want to use. Created PIN codes must have the specified length, and must consist of alphanumeric characters. For example:

       [User]
       PincodeLength=8

4. Save and close the configuration file.

5. Restart the Community componentfor your changes to take effect.

## Add a PIN Code for a User

When you enable PIN codes in the configuration file, you can assign them to users by sending a `UserPin` action.

To add or change a PIN code

- Send the following action to the Community component:

      http://CommunityHost:CommunityPort/action=UserPin&UserName=Username&Pincode=PinValue

  where:

  `CommunityHost` | is the name or IP address of the host on which the Community component runs.
  `CommunityPort` | is the Community component ACI port.
  `Username` | is the name of the user for which you want to add a PIN code.
  `PinValue` | is the value of the new pin.

## Authenticate Users with PIN Codes

You authenticate users with PIN codes by using the `UserPin` action. This action can check certain characters in the PIN code, rather than the whole PIN code.

To authenticate a PIN code

- Send the following action to the Community component:

      http://CommunityHost:CommunityPort/action=UserPin&UserName=Username&Positions=Positions&Values=Values

  where:

  `CommunityHost` | is the name or IP address of the host on which the Community component runs.
  `CommunityPort` | is the Community component ACI port.
  `Username` | is the user name of the user whose account you want to authenticate.
  `Positions` | is a comma-separated list of the positions in the PIN code that you want to check.
  `Values` | is a comma-separated list of the values that Community must check against the specified positions.

For example, to authenticate by using the third, fifth, and sixth characters from a PIN code, you must set `Positions` to `3,5,6`. The `Values` parameter then contains the values that the user provides, for example `y,9,a`. Community checks that the specified values occur at the specified positions in the PIN code.

Copyright 2025 Open Text
Version 26.1 | Last updated January 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Category Component 26.1

Topic Title: Create User PIN Codes