Access Token for UiPath

Configure an access token to connect to UiPath.

Figure: UiPath Access Token Configuration screen

UiPath Access Token Configuration screen

Background and Setup

Prerequisites

Good to Know

  • In most cases, you can use a global access token or an application level access token:
    • Global access tokens are shared across all users and applications. 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 Google Drive 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 application level access tokens apply to all versions of an application, 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?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 Name Definition

Token Name

Function:
Specifies the unique name for your connection to UiPath.
Accepted Values:
A text string that can have letters, numbers, and spaces
Default Value:
None

Description

Function:
A description for your access token.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Orchestrator API URL

Function:
Specifies the URL of your UiPath environment.
Accepted Values:
The URL of a UiPath Orchestrator environment.
Default Value:
https://platform.uipath.com

Tenant Name

Function:
Specifies the tenant name for your UiPath environment.
Accepted Values:
One line of text with no spaces.
Default Value:
None

User Name or E-mail

Function:
Specifies the user name or e-mail address for UiPath authentication.
Accepted Values:
A user name or e-mail address registered in UiPath.
Default Value:
None

Password

Function:
Specifies a password for the UiPath authentication account.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None

OAuth2 Access Token

Function:
Specifies an access token, or code, from UiPath.
Accepted Values:
A valid access token

This value comes from UiPath.

Default Value:
None

Get OAuth2 Access Token

Function:
Sends a request to the UiPath service to get the access token.

To complete this process, you must sign in to UiPath, and specify your consent when prompted.

Renewal Rate

Function:
Specifies how frequently to renew your application's access token.
Accepted Values:
  • Disabled
  • Every 10 minutes
  • Every 15 minutes
  • Every half an hour
Default Value:
Every 15 minutes

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 PrivateCloud 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.