Access Token for Microsoft Dataverse

Configure an access token to connect to Microsoft Dataverse.

Figure: Microsoft Dataverse Access Token Configuration screen

Common Data Service Access Token Configuration screen

Background and Setup

Examples

Prerequisites

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

  • OAuth 2.0 access tokens require a 2-way exchange of credentials between AgilePoint NX and the external service. This means that you must get the credentials from the third-party service to paste in the AgilePoint NX access token, and get the redirect URI from AgilePoint NX to paste in the external service. This requires you to open both the AgilePoint NX access token and the third-party service at the same time, so you can copy and paste from one screen to the other.

    This topic shows the suggested procedure for Microsoft Dataverse. The exact procedure for your access token depends on whether you already have a connection (usually called an app) configured in the external service.

    (Example) How to Get the Access Token Credentials from Microsoft Dataverse.

  • 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 Name Definition

Token Name

Function:
Specifies the unique name for your connection to Microsoft Dataverse.
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.

Application ID

Function:
Specifies the ID of the app you created or added for Microsoft Dataverse.

Once you register the app in Microsoft Azure Active Directory, your application ID shows.

Accepted Values:
A string with letters and numbers.
Default Value:
None
Example:
Refer to:

Key

Function:
Specifies the key of the app you created or added for Microsoft Dataverse in Microsoft Azure Active Directory.
Accepted Values:
A string with letters and numbers.
Default Value:
None
Example:
Refer to:

Reply URL

Function:
Specifies the callback URL from the connected application.
Accepted Values:
A string in URL format.
Default Value:
https://mysite.com/manage/shared/success.html

Access Token EndPoint URL

Function:
Specifies your endpoint URL for the Microsoft Dataverse access token.

The default value for this field is the value of the endpoint URL for the global region. If you use the access token for a specific region, see the documentation from Microsoft to get the endpoint URL for your region.

Accepted Values:
An endpoint URL for Microsoft Dataverse.
Default Value:
https://login.microsoftonline.com

Organization URI

Function:
Specifies the Organization URL of the environment you created for Microsoft Dataverse.

When you create the environment in Microsoft Power Apps, your organization URL shows.

Accepted Values:
An organization URL from Microsoft Power Apps.
Default Value:
https://[yourorg].crm.dynamics.com
Example:
Refer to:

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.

OAuth 2.0 Access Token

Function:
Specifies an OAuth 2.0 access token from Microsoft Dataverse.
Accepted Values:
An OAuth 2.0 access token.

This value comes from Microsoft Dataverse.

Default Value:
None.
Example:
Refer to:

Get OAuth 2.0 Access Token

Function:
Sends a request to the Microsoft Dataverse to get the access token.

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

Renewal Rate

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