Establishing a Connection
The objects available within our connector are accessible from the "cdata.odata" module. In order to use the module's objects directly, the module must first be imported as below:
import cdata.odata as mod
From there, the connect() method can be called from the connector object to establish a connection using an appropriate connection string, such as the below:
Connecting to OData
To connect, you need to set the Url to a valid OData service root URI in addition to the authentication values.
Also, you can specify a CacheLocation to store the metadata of your OData organization. This keeps the CData Python Connector for OData from having to send requests for metadata on each connection.
Authenticating to OData
The provider supports following authentication schemes.
HTTP Auth Schemes
The following general HTTP Auth schemes are supported:
- None: If no authentication is required, set the AuthScheme to None.
- Basic: If Basic Auth is supported, set the AuthScheme to Basic. In addition, set the User and Password.
- NTLM: A type of Windows authentication often used across a LAN using your Windows user credentials. Set the AuthScheme to NTLM to support this method of authentication. In addition, set the User and Password if you are not connecting from a Windows machine, or your currently logged in user account should not be used for the connection.
- Digest: If Digest Auth is supported, set the AuthScheme to Digest. In addition, set the User and Password.
Kerberos AuthenticationPlease see Using Kerberos for a description of how to support Kerberos authentication.
Authenticating with OAuth
Set the AuthScheme to OAuth. See Using OAuth Authentication for an authentication guide.
Authenticating with AzureAD
AzureAD is a form of OAuth that goes through Azure. Set the AuthScheme to AzureAD. The CData Python Connector for OData will internally automatically take care of known Azure URLs. Specifically, the following are unnecessary to specify with the AzureAD AuthScheme:
Other connection properties may be required for this connection method including:
- Scope: Must be specified if InitiateOAuth is set to GETANDREFRESH as the Scope is submitted to Microsoft during retrieval of credentails. This will vary depending on the service, but is generally a combination of the resource (hostname in the URL) and permission name. For example: https://host/user_impersonation.
- AzureADTenant: The specific Azure Tenant to authenticate against during Microsoft login. If none is specified, your user account's default tenant via the common login endpoint will be used. This may not be correct depending on the specific resource you are connecting to. For example, if the resource is stored on a seperate tenant for cases where you have access to multiple tenants.
Otherwise, the steps are identical to the Using OAuth Authentication guide.
Authenticating with SharePoint Online
SharePoint Online connections may be established by retrieving a SharePoint Online cookie. Specify the following connection properties to authenticate:
- AuthScheme: Set this to SharePointOnline.
- User: Set this to your SharePoint Online user account.
- Password: Set this to your SharePoint Online password.
Securing OData Connections
By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.