Connecting to HTTP or HTTPS

Version 24.1.8910


Connecting to HTTP or HTTPS


In CData Sync, you can connect to HTTP or HTTPS in several ways. Select your authentication method below, then proceed to the relevant section and follow those instructions.

None

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

Complete the remaining steps for establishing your connection.

Basic

To connect with user credentials, specify the following settings:

  • Auth Scheme - Select Basic.

  • User - Enter the username that you use to authenticate to the HTTP stream.

  • Password - Enter the password that you use to authenticate to the HTTP stream.

Complete the remaining steps for establishing your connection.

Digest

To connect with the digest scheme, specify the following settings:

  • Auth Scheme - Select Digest.

  • User - Enter the username that you use to authenticate to the HTTP stream.

  • Password - Enter the password that you use to authenticate to the HTTP stream.

Complete the remaining steps for establishing your connection.

OAuth

To connect with an OAuth access token, specify the following settings:

  • Auth Scheme - Select OAuth.

  • OAuth Version - Select your OAuth version. The default version is 2.0.

  • 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 - Enter the URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.

  • OAuth Access Token URL - Enter the URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.

  • OAuth Refresh Token URL - Enter the URL from which to refresh the OAuth token.

  • Scope (optional) - Enter the scope that you want to use to obtain the initial access and refresh token.

Complete the remaining steps for establishing your connection.

OAuth JWT

To connect with JWT, specify the following properties:

  • Auth Scheme - Select OAuthJWT.

  • OAuth Version - Use the default version, 2.0.

  • OAuth Access Token URL - Enter the URL where the JWT is exchanged for an access token.

  • OAuth JWT Cert - Enter your Java web tokens (JWT) certificate store.

  • OAuth JWT Cert Type - Enter the type of key store that contains your JWT certificate. The default type is PEMKEY_BLOB.

  • Scope (optional) - Enter the scope that you want to use to obtain the initial access and refresh token.

  • OAuth JWT Cert Password (optional) - Enter the password for your OAuth JWT certificate.

  • OAuth JWT Cert Subject (optional) - Enter the subject of your OAuth JWT certificate.

Complete the remaining steps for establishing your connection.

OAuth Password

To connect with the Password OAuth grant type, specify the following properties:

  • Auth Scheme - Select OAuthPassword.

  • User - Enter the username that you use to authenticate to the HTTP stream.

  • Password - Enter the password that you use to authenticate to the HTTP stream.

  • OAuth Version - Use the default version, 2.0.

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

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

  • Scope (optional) - Enter the scope that you want to use to obtain the initial access token.

  • OAuth Access Token URL (optional) - Enter the URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.

Complete the remaining steps for establishing your connection.

OAuth Client

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

  • Auth Scheme - Select OAuthClient.

  • OAuth Version - Use the default version, 2.0.

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

  • Scope (optional) - Enter the scope that you want to use to obtain the initial access token.

  • OAuth Access Token URL (optional) - Enter the URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.

Complete the remaining steps for establishing your connection.

OAuthPKCE

To connect with OAuth PKCE extension, specify the following properties:

  • Auth Scheme - Select OAuthPKCE.

  • OAuth Version - Use the default version, 2.0.

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

Complete the remaining steps for establishing your connection.