Access Token for AgilePoint NX

Configure an access token to connect to AgilePoint NX.

Figure: AgilePoint NX Access Token Configuration screen

AgilePoint NX Access Token Configuration screen

Background and Setup

Good to Know

Fields

Field NameDefinition

Token Name

Description:
Specifies the unique name for your connection to AgilePoint NX.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • 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

Description:
A description for your access token.
Allowed 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

Description:
Specifies the user account to connect to AgilePoint NX.
Allowed Values:
Default Value:
Custom User

REST Service URL

Description:
Specifies the REST AgilePoint Service URL for your tenant.

For more information, refer to Find Your AgilePoint Service URL in AgilePoint NX.

To Open this Field:
  1. Click Connect to Other AgilePoint Server.
Allowed Values:
A valid AgilePoint service URL.
Default Value:
None

User Name

Description:
Specifies the user name for AgilePoint NX authentication.
Allowed Values:
A valid user name.
Default Value:
None
Accepts Variables:
No

Password

Description:
The password for the authentication account.
To Open this Field:
  1. On the SFTP Access Token screen, click Password Authentication.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Variables:
No

Authorization

Description:
Specifies an authorization value to connect to AgilePoint NX.
Allowed Values:
A valid authorization value.

When you click Generate button, this field completes.

Default Value:
None

Test Connection

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

Enable Password Expiry Notification

Description:
Specifies whether to send an email notification when the password is due to expire.
Allowed Values:
  • Selected - Sends an email notification before the password expires.

    By default, this notification is sent 15 days before expiration.

  • Deselected - Does not send an email notification for the password expiration.
Default Value:
Deselected
Limitations:

This field is available in these releases:

Date

Description:
Specifies the date the authentication credentials for the access token expire.

AgilePoint NX sends the notification 15 days before the date specified in the Date field.

Allowed Values:
A date from the calendar.
  • MM/dd/yyyy - Shows the date in the format Month/day/year.
Default Value:
None
Limitations:

This field is available in these releases:

Email

Description:
Specifies the email address of the user to whom to send the notification about the password expiration.
Allowed Values:
One line of text (a string) in email address format.
Default Value:
None
Limitations:

This field is available in these releases:

Encrypt

Description:
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.
Allowed 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.