Access Token for Active Directory

Configure an access token to connect to Active Directory.

Figure: Active Directory Access Token Configuration screen

Active Directory Access Token Configuration screen

Background and Setup

Good to Know

Fields

Field Name Definition

Token Name

Function:
Specifies the unique name for your connection to Active Directory.
Accepted Values:
A text string that can have letters, numbers, and spaces
Default Value:
None
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
A description for your access token.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

User Account

Function:
Specifies the user account to connect to Active Directory.
Accepted Values:
Default Value:
Custom User

Context Domain

Function:
Specifies the name of your Active Directory domain.
To Open this Field:
  1. On the Active Directory access token screen, select Custom User.
Accepted Values:
A valid Active Directory domain name.
Default Value:
None

User Name

Function:
Specifies the user name of the account to use to create a group in Active Directory.
To Open this Field:
  1. On the Active Directory access token screen, select Custom User.
Accepted Values:
A valid user name.
Default Value:
None
Accepts Process Data Variables:
No

Password

Function:
Specifies the password of the account to use to create a group in the domain
To Open this Field:
  1. On the Active Directory access token screen, select Custom User.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Process Data Variables:
No

Directory Type

Function:
Specifies the format for your Active Directory.
Accepted Values:
  • LDAP - Specifies your Active Directory uses LDAP.
  • WinNT - Specifies your Active Directory uses WinNT.
Default Value:
LDAP

Directory Address

Function:
Specifies a host address for your Active Directory.
To Open this Field:
  1. On the Active Directory access token screen, select Custom User.
Accepted Values:
  • IP address - The IP address of the Active Directory. For example, 211.325.5.3.
  • IP address/[relative distinguished name (RDN)] - The IP address of the Active Directory with the container name (CN), organizational unit (OU), or both for the user. For example, 211.325.5.3/OU=MyGroup
Default Value:
None

Directory Port

Function:
Specifies a port number of the Active Directory.
To Open this Field:
  1. On the Active Directory access token screen, select Custom User.
Accepted Values:
A valid port number for your Active Directory.
Default Value:
389

Test Connection

Function:
Makes sure the specified Active Directory account is correct.

Encrypt

Function:
Stores the access token in the AgilePoint database as encrypted data.
Note: AgilePoint recommends you to store this access token in the database in encrypted format.
Accepted Values:
  • Deselected - The access token is in plain text in the database.
  • Selected - The access token is encrypted in the database.
Default Value:
Selected
Limitations:
  • This field was removed from the UI in AgilePoint NX OnPremises and Private Cloud v7.0 Software Update 2. Access token credentials are encrypted by default. If you want to store credentials in unencrypted format, contact AgilePoint Customer Support.