Access Token for REST Service

Configure an access token to connect to a REST service.

Figure: REST Service Access Token Configuration screen

REST Service Access Token Configuration screen

Background and Setup

Examples

Good to Know

  • In most cases, you can use a global access token or an app level access token:
    • Global access tokens are shared across all users and apps. If you want all process designers and runtime app users in your AgilePoint NX tenant to be able to connect to an external data source, use a global access token. An example is a SharePoint site on an intranet that all employees in a company can access.
    • Application level access tokens are shared with all processes in a process-based app, or restricted to use within a form-based app. Use application level access tokens if only process designers or runtime app users for a particular application should access an external system — for example, a Box account that is only used to share files within a small team.
  • Access tokens are collections of credentials that are used to authenticate communication directly between AgilePoint NX and an external system. Because it is the AgilePoint NX system that uses these credentials, rather than an app, there is no difference between design time and runtime access tokens. Access tokens are never checked in or published, and they do not use version control. If you change an access token in App Builder or Manage Center, the access token changes immediately everywhere the access token is used. Changes to app level access tokens apply to all versions of an app, including running application instances. Changes to global access tokens apply everywhere they are used in AgilePoint NX. You can not roll back an access token to a previous version.

    For more information, refer to What Data Is Deleted When I Delete an App or Application Resource?

  • This screen may look different in different places. The UI varies for this screen depending upon how you open it. However, the fields for this screen are the same in all places.
  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Fields

Field NameDefinition

Token Name

Description:
Specifies the unique name for your connection to REST service.
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.

Service URL

Description:
Specifies the URL of your REST service.
Allowed Values:
A valid rest service URL.
Default Value:
None
Example:
Refer to:

Action

Description:
Specifies the type of action for the REST service to do.
Allowed Values:
  • POST
  • GET
  • DELETE
  • PUT
  • PATCH
Default Value:
None
Example:
Refer to:

Content-Type

Description:
Specifies the type of content the REST service uses.
Allowed Values:
  • JSON
  • XML
Default Value:
None
Example:
Refer to:

Accept

Description:
Specifies the data format to accept in a REST service.
Allowed Values:
  • JSON
  • XML
  • TEXT
Default Value:
None
Example:
Refer to:

Protocol

Description:
Specifies the communication protocol for your REST service.
Allowed Values:
  • HTTP 1.0
  • HTTP 1.1
Default Value:
HTTP 1.0
Example:
Refer to:

Request Timeout

Description:
Specifies the maximum amount of time, in seconds, to complete the REST service call for the activity.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
600

Read Write Timeout

Description:
Specifies the maximum amount of time, in seconds, for read and write methods.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
600

Request Headers

Description:
Specifies the custom headers necessary for the REST service.

Request headers contain application-specific information in the SOAP header. Request headers are usually used to give security information, such as authentication credentials.

Allowed Values:
  • Header
  • Value

Use the Add Header button to add the Header and Value for the web service.

Default Value:
None

Add Header

Function:
Adds the row for Header and Value fields.

Update

Function:
Changes the information in the Header and Value fields.

Cancel

Function:
Deletes the row with Header and Value fields.

Configure

Opens this Screen:
To Open this Field:
  1. Click the Authentication tab.

Bypass Test

Function:
Specifies whether to verify the REST service configuration.
Allowed Values:
  • Selected - REST service verification is bypassed, and the configuration is assumed to be valid.
  • Deselected - REST service verification is required.
Default Value:
Deselected

Test Connection

Function:
Makes sure the specified REST service account is correct.

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.

Access Token for REST Service > Authentication screen > Basic Authentication tab

Creates REST service authentication credentials to connect to a REST service URL with basic authentication.

Screen



Fields

Field NameDefinition

User Name

Description:
Specifies the user name for REST service authentication.
Allowed Values:
A valid user name.
Default Value:
None
Example:
Refer to:

Password

Description:
The password for the authentication account.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Example:
Refer to:

Authorization

Description:
Specifies an authorization value to connect to the REST service.
Allowed Values:
A valid authorization value.

When you click Generate button, this field completes.

Default Value:
None

Generate

Function:
Gives the authorization value to connect to the REST service.

Insert

Function:
Adds the authorization name and value in the Header and Value field.

Reset

Description:
Deletes the REST service authentication credentials.

Access Token for REST Service > Authentication screen > OAuth 2.0 tab

Creates REST service authentication credentials to connect to a REST service URL with the OAuth 2.0 protocol.

Screen



Fields

Field NameDefinition

Token Type

Description:
Specifies the name of an external system, such as SharePoint, Google Drive, or Box from the list.
Allowed Values:
The name of an external system.
Default Value:
None

Token

Description:
Specifies the access token for the specified external system.
Allowed Values:
An access token from the list.
Default Value:
None.

When you select an external system from the Token Type field, the name of the access token for the specified system shows in this field.

Add Global Access Tokens > REST Service > Authentication screen > Windows Authentication tab

Creates REST service authentication credentials to connect to a REST service URL with Windows Authentication (NTLM).

Figure: Windows Authentication tab (REST Service Authentication)

Windows Authentication tab REST Service Authentication

Prerequisites

Fields

Field NameDefinition

Domain

Description:
The domain for the REST service authentication.
Allowed Values:
A valid domain.
Default Value:
None

User Name

Description:
Specifies the user name for the REST service authentication.
Allowed Values:
A valid user name.
Default Value:
None

Password

Description:
The password for the authentication account.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Example:
Refer to: