Access Token for REST Service

Configure an access token to connect to a REST service.

Figure: REST Service Access Token Configuration screen

Background and Setup

Examples

(Example) Create a REST Service Access Token

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 the 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?

How to Start

There are several ways to create an access token for REST service. How to create the access token depends on where you want to use it.

Global (Manage Center)

You can use a global access token in any app in your AgilePoint NX tenant. Use a global access token if you want any user in your environment to be able to connect to the same external system.

Click Manage.
Click App Builder > Global Access Tokens.
On the Global Access Tokens screen, click Add Token.
On the Add Global Access Tokens screen, select REST Service.
Click Next.

App Level (Process-Based App, Modern Add an App Experience)

Create an access token to use in any process activity or form control in a process-based app you create in the Modern Add an App Experience.

In App Builder, in the Modern Add an App Experience, create a process-based app.
For more information, refer to:
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select REST Service.
Click Next.

App Level (Form-Based App, Modern Add an App Experience)

Create an access token to use in any form control in a form-based app you create in the Modern Add an App Experience.

In App Builder, in the Modern Add an App Experience, create a form-based app.
For more information, refer to:
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select REST Service.
Click Next.

App Level (App Explorer)

Create an access token to use in any process activity or form control in a specified app.

Click App Builder.
In the Application Explorer, on the My Apps pane, click [App Name] > Shared Resources > Access Tokens.
Click New.
On the New Access Token screen, select REST Service.
Click Next.

Process Activities and Form Controls

Different access token types can be created in context and used in different process activities, form controls, or apps. The App Builder shows shortcut buttons in any place you can create an access token.

You can create an app level access token for a REST service here:

eForm Builder
- Auto Lookup form control
- Auto-Suggest form control
- List Box form control
- Check Box form control
- List View form control
- Map form control
- Pop-Up Select form control
- Drop-Down List form control
- Auto-Suggest form control
- Chart form control
- Drop-Down List form control
- Multi-Select List Box form control
Process Builder
- This activity on the Web Services tab:
  - REST Service activity

Fields

Field Name	Definition
Token Name	Function: Specifies the unique name for your connection to REST service. Accepted 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	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.
Service URL	Function: Specifies the URL of your REST service. Accepted Values: A valid rest service URL. Default Value: None Example: Refer to: (Example) Create a REST Service Access Token
Action	Function: Specifies the type of action for the REST service to do. Accepted Values: POST GET DELETE PUT PATCH Default Value: None Example: Refer to: (Example) Create a REST Service Access Token
Content-Type	Function: Specifies the type of content the REST service uses. Accepted Values: JSON XML Default Value: None Example: Refer to: (Example) Create a REST Service Access Token
Accept	Function: Specifies the data format to accept in a REST service. Accepted Values: JSON XML TEXT Default Value: None Example: Refer to: (Example) Create a REST Service Access Token
Protocol	Function: Specifies the communication protocol for your REST service. Accepted Values: HTTP 1.0 HTTP 1.1 Default Value: HTTP 1.0 Example: Refer to: (Example) Create a REST Service Access Token
Request Timeout	Function: Specifies the maximum amount of time, in seconds, to complete the REST service call for the activity. Accepted Values: An integer, representing a number of seconds. Default Value: 600
Read Write Timeout	Function: Specifies the maximum amount of time, in seconds, for read and write methods. Accepted Values: An integer, representing a number of seconds. Default Value: 600
Request Headers	Function: 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. Accepted 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: 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. 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. 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). To Open this Field: Click the Authentication tab.
Bypass Test	Function: Specifies whether to verify the REST service configuration. Accepted Values: Selected - REST service verification is bypassed, and 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	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.