Version 25.3.9396

• Add the OData Connector
• Authenticate to OData
  • None
  • Azure Active Directory
  • Basic
  • Digest
  • Negotiate
  • NTLM
  • OAuth
  • OAuth Password
  • OAuth Client
  • SharePoint Online
• Complete Your Connection
• More Information

You can use the OData connector from the CData Sync application to capture data from OData and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the OData Connector

To enable Sync to use data from OData, you first must add the connector, as follows:

1. Open the Connections page of the Sync dashboard.

2. Click Add Connection to open the Select Connectors page.

3. Click the Sources tab and locate the OData row.

4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the OData connector. For more information about installing new connectors, see Connections.

Authenticate to OData

After you add the connector, you need to set the required properties.

• Connection Name - Enter a connection name of your choice.

• URL - Enter the URL to your organization root or to the OData services file.

  • Auth Scheme - Select the authentication scheme that you want to use. The default setting is None.

CData Sync supports authenticating to OData in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

• None
• Azure Active Directory
• Basic
• Digest
• Negotiate
• NTLM
• OAuth
• OAuthPassword
• OAuthClient
• SharePointOnline

None

To connect without authentication, select None for Auth Scheme. No additional properties are required.

Azure Active Directory

To connect with an Azure Active Directory (AD) user account, specify the following properties:

• Auth Scheme - Select AzureAD.

• Azure Tenant - Enter the OData tenant that is used to access data. Enter either the name (for example, YourTenantName.com) or the identifier (for example, Conditional).

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

Basic

To connect with your user credentials, set the following properties:

• Auth Scheme: Select Basic.

• User: Enter the username that you use to authenticate to your OData account.

• Password: Enter the password that you use to authenticate to your OData account.

Digest

To connect with your user credentials, set the following properties:

• Auth Scheme: Select Digest.

• User - Enter the username that you use to authenticate to your OData account.

• Password - Enter the password that you use to authenticate to your OData account.

Negotiate

To connect with your user credentials, set the following properties:

• Auth Scheme: Select Negotiate.

• Kerberos KDC - Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.

• Kerberos SPN - Enter the service principal name (SPN) for the Kerberos domain controller.

NTLM

To connect with NTLM user credentials, specify the following properties:

• Auth Scheme – Select NTLM.

• User - Enter the username that you use to authenticate to your OData account.

• Password - Enter the password that you use to authenticate to your OData account.

OAuth

To connect with OAuth custom credentials, specify the following properties:

• Auth Scheme – Select OAuth.

• Initiate OAuth - Select the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

  • OFF - By choosing this setting, automatic OAuth-flow initiation is turned off. The OAuth flow is handled entirely by the user. With this setting, the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.

  • REFRESH - When you choose this setting, the OAuth flow is handled entirely by the Sync application. If a token exists already, it is refreshed when necessary. If no token currently exists, it is obtained by prompting the user to login.

  • GETREFRESH - With you select this setting, the user is responsible for obtaining the initial OAuth access token and for configuring the refresh sequence. The user is not prompted to log in for authentication. After the initial login, the Sync application automatically manages the OAuth access token refresh process.

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Authorization URL (optional) - Enter the OAuth authorization URL that you need to authorize request tokens when you sign in.

• OAuth Access Token URL (optional) - Enter the URL where the request for the access token is made.

• OAuth Refresh Token URL (optional) - Enter the URL where the refresh token is exchanged for a new access token when the old one expires. Note that for your data source, this URL might be the same as the access-token URL.

OAuth Password

To connect with OAuth via a password grant type, specify the following properties:

• Auth Scheme – Select OAuthPassword.

• User - Enter the username that you use to authenticate to your OData account.

• Password - Enter the password that you use to authenticate to your OData account.

• Initiate OAuth - Select the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

  • OFF - By choosing this setting, automatic OAuth-flow initiation is turned off. The OAuth flow is handled entirely by the user. With this setting, the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.

  • REFRESH - When you choose this setting, the OAuth flow is handled entirely by the Sync application. If a token exists already, it is refreshed when necessary. If no token currently exists, it is obtained by prompting the user to login.

  • GETREFRESH - With you select this setting, the user is responsible for obtaining the initial OAuth access token and for configuring the refresh sequence. The user is not prompted to log in for authentication. After the initial login, the Sync application automatically manages the OAuth access token refresh process.

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Access Token URL (optional) - Enter the URL where the request for the access token is made.

• OAuth Refresh Token URL (optional) - Enter the URL where the refresh token is exchanged for a new access token when the old one expires. Note that for your data source, this URL might be the same as the access-token URL.

OAuth Client

To connect with OAuth via a client grant type, specify the following properties:

• Auth Scheme – Select OAuthPassword.

• Initiate OAuth - Select the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

  • OFF - By choosing this setting, automatic OAuth-flow initiation is turned off. The OAuth flow is handled entirely by the user. With this setting, the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.

  • REFRESH - When you choose this setting, the OAuth flow is handled entirely by the Sync application. If a token exists already, it is refreshed when necessary. If no token currently exists, it is obtained by prompting the user to login.

  • GETREFRESH - With you select this setting, the user is responsible for obtaining the initial OAuth access token and for configuring the refresh sequence. The user is not prompted to log in for authentication. After the initial login, the Sync application automatically manages the OAuth access token refresh process.

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Access Token URL (optional) - Enter the URL where the request for the access token is made.

• OAuth Refresh Token URL (optional) - Enter the URL where the refresh token is exchanged for a new access token when the old one expires. Note that for your data source, this URL might be the same as the access-token URL.

SharePoint Online

To connect with SharePoint Online credentials, specify the following properties:

• User - Enter the username that you use to authenticate to your OData account.

• Password - Enter the password that you use to authenticate to your OData account.

Complete Your Connection

To complete your connection:

1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

2. If you authenticate with AzureAD or OAuth, click Connect to OData to connect to your OData account.

3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and OData, see OData Connector for CData Sync.