ODBC Driver for REST

Build 25.0.9434

AuthScheme

The type of authentication to use when connecting to remote services.

Possible Values

AccessKey, AwsCredentialsFile, AwsTempCredentials, AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert, AzureStorageSAS, Basic, Digest, GCPInstanceAccount, IAMSecretKey, Negotiate, None, OAuth, OAuthClient, OAuthJWT, OAuthPassword, OAuthPKCE, SFTP,

Data Type

string

Default Value

""

Remarks

The following options are available:

  • AccessKey: Set this to authenticate with the storage key associated with your Azure account.
  • AwsCredentialsFile: Set to use a credential file for authentication.
  • AwsTempCredentials: Set this to leverage temporary security credentials alongside a session token to connect.
  • AzureAD: Set this to perform Azure Active Directory OAuth authentication.
  • AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
  • AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.
  • AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.
  • AzureStorageSAS: Set this to authenticate with Shared Access Signature (SAS).
  • Basic: Basic user/password authentication.
  • Digest: Uses HTTP Digest authentication with User and Password.
  • GCPInstanceAccount: When running on a GCP virtual machine, the provider can authenticate using a service account tied to the virtual machine.
  • IAMSecretKey: Uses AccessKey and SecretKey to authenticate to the Oracle Cloud Storage.
  • Negotiate: Kerberos authentication.
  • None: No authentication is used.
  • OAuth: Uses OAuth with a standard user account. The specific flow is determined by the InitiateOAuth, and OAuthVersion must be set to determine what version of OAuth is used.
  • OAuthClient: Uses OAuth2 with the client credentials grant type. OAuthClientId and OAuthClientSecret are the credentials. OAuthVersion must be set to 2.0.
  • OAuthJWT: Uses OAuth2 with the JWT bearer grant type. OAuthJWTCertType and OAuthJWTCert determine what certificate the JWT is signed with. OAuthVersion must be set to 2.0.
  • OAuthPassword: Uses OAuth2 with the password grant type. User and Password are the credentials. OAuthVersion must be set to 2.0.
  • OAuthPKCE: Uses OAuth2 with the authorization code grant type and PKCE extension. OAuthClientId is the credential. OAuthVersion must be set to 2.0.
  • SFTP: The precise authentication method is controlled using the SSHAuthMode property. See this property's documentation for further information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434