Articles in this section

How to enable a Custom Data Connector

This article explains how to configure a Custom Data Connector from the Admin Center. Before setting up a Custom Data Connector, you must have an OData V4 service available to query your data.

  Prerequisites

Set up in Templafy

  1. In the Admin Center, access Integrations section.
  2. Go in Available tab.
  3. Find/Search for Custom Data Connector.
  4. Click +.
  5. Enter the required information:
    • Display Name
    • Base URL
    • Authentication type - select the option that matches your data source.

Authentication types

Type Description
None For publicly accessible OData endpoints that require no credentials.
Bearer Token Authenticate using a static bearer token.
Custom Header Send a custom header name and value. Previously labelled "Authorization Header" — existing connectors using this method are automatically migrated.
OAuth 2.0 Client Credentials Machine-to-machine authentication using a Client ID and Client Secret. Tokens are acquired and refreshed automatically. Recommended for most enterprise integrations.
OAuth 2.0 Authorization Code User-delegated authentication. The admin is redirected to the identity provider to grant access. Supports optional PKCE. Tokens are managed and refreshed automatically.

Follow the relevant section below for your chosen authentication type.

None

No additional fields are required. Click Save.

Bearer Token

  1. In the Bearer token field, enter "Bearer " (with a space after the word "Bearer") followed by your static token. 
    This should look like "Bearer token_value". 
  2. Click Save.

Custom Header

  1. In the Header name field, enter the name of the header (e.g. "Authorization").
  2. In the Header value field, enter the corresponding value.
  3. Click Save.

OAuth 2.0 Client Credentials

Recommended for machine-to-machine.

Before you begin: Register Templafy as a client application in your identity provider (IdP) and obtain the Client ID, Client Secret, Token Endpoint, and Scope values.

  1. In the Client ID field, enter the Client ID from your IdP app registration.
  2. In the Client secret field, enter the Client Secret.
  3. In the Token endpoint field, enter the token URL from your IdP.
  4. Optionally, enter any required Scopes.
  5. Click Save. Templafy will automatically acquire and refresh tokens — no further login step is required.

OAuth 2.0 Authorization Code

For user-delegated access.

Before you begin: Register Templafy as a client application in your identity provider (IdP) and obtain the Client ID, Client Secret, Authorize URL, Token Endpoint, and Scope values. You must also add the following redirect URI to your IdP app registration:

https://public.templafy.com/api/integrations/oauth2-connectors/v2/oauth2/callback

  1. In the Client ID field, enter the Client ID from your IdP app registration.
  2. In the Client secret field, enter the Client Secret.
  3. In the Authorize URL field, enter the authorization endpoint URL from your IdP.
  4. In the Token endpoint field, enter the token URL from your IdP.
  5. Optionally, enter any required Scopes.
  6. Optionally, check Use PKCE code verifier to enable PKCE for enhanced security. This is recommended where supported by your IdP.
  7. Click Save.
  8. On the installed connector card, click the Log in button and complete the authentication flow in your identity provider. Templafy will manage and refresh the token automatically going forward.

Refresh Token

Templafy supports the OAuth 2.0 Refresh Token Flow for connectors using the OAuth 2.0 Authorization Code authentication type. When the identity provider returns a refresh token, Templafy uses it to renew access tokens automatically, so administrators do not need to log in again when the access token expires. Refresh tokens are only issued when the identity provider chooses to return one. For OIDC-compliant providers, this typically requires requesting the 'offline_access' scope.

  Important

If the token cannot be refreshed (e.g. the refresh token has expired or been revoked), you will need to re-authenticate by clicking Log in on the connector card.

  Note

  • Templafy connection to client endpoint supports SNI.
  • Templafy connection to client endpoint supports non-standard https ports.
  • Once the data connector has been set up, you can navigate to the Resources to add the relevant external data sources.

 

data Microsoft Teams data connector admin_role
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.