Skip to main content
Administrator Guide
Last Updated: 2026-08-07
Set Up Live Data Query Using Python Client and Driver

Set Up Live Data Query Using Python Client and Driver

You can connect to Live Data Query using a Python script.
  1. Create the
    dataservice.properties
    file with the following configuration details using the property=value format. For sample code, see the Example section below.
    We recommend that you place the properties file and the connector wheel file in the same Python project directory before installation and execution.
    Property
    ISU
    User-As-Self
    wd.authn.authModel
    JWT_BEARER
    AUTHORIZATION_CODE
    wd.authn.clientId
    Client ID created in the Live Data Query ISU setup.
    Client ID created in the User-As-Self Authentication setup.
    wd.authn.clientSecret
    N/A
    Client secret created in the User-As-Self Authentication setup.
    wd.authn.isu
    Your ISU.
    N/A
    wd.authn.accessTokenEndpoint
    Token endpoint created in the Live Data Query ISU setup.
    Example:
    https://{HOST1}/ccx/oauth2/{TENANT}/token
    If the client is behind a proxy server, specify
    wd.authn.accessTokenEndpoint=<proxy TokenEndpoint>
    .
    Token endpoint created in the User-As-Self Authentication setup.
    Example:
    https://{HOST1}/ccx/oauth2/{TENANT}/token
    If the client is behind a proxy server, specify
    wd.authn.accessTokenEndpoint=<proxy TokenEndpoint>
    .
    wd.authn.authorizationEndpoint
    N/A
    Authorization endpoint created in the User-As-Self Authentication setup.
    Example:
    https://{HOST2}/{TENANT}/authorize
    wd.authn.privateKeyFilePath
    The full path of the private key file.
    • Windows Example:
      C:\Users\user.name\Documents\<privateKeyFile.txt>
    • Mac Example:
      /Users/path/to/your/private_key.pem
    For a Windows machine, you must specify the
    wd.authn.privateKeyFilePath
    property.
    The
    wd.authn.privateKey
    and
    wd.authn.privateKeyFilePath
    properties are mutually exclusive. If you specified
    wd.authn.privateKey
    , don’t specify
    wd.authn.privateKeyFilePath
    .
    N/A
    wd.authn.privateKey
    The
    wd.authn.privateKey
    and
    wd.authn.privateKeyFilePath
    properties are mutually exclusive. If you specified
    wd.authn.privateKey
    , don’t specify
    wd.authn.privateKeyFilePath
    .
    Privacy-Enhanced Mail (PEM) format text. Must include the header/footer.
    For information about the private key, see Generate Public and Private Keys for Workday Live Data Query.
    N/A
    wd.authn.redirectURL
    N/A
    https://localhost:8888/callback
    wd.host
    The {HOST1} value from the Token Endpoint on the API Client you created in the ISU setup.
    If the client is behind a proxy server, specify
    wd.host=<proxy host>
    .
    The {HOST1} value from the Token Endpoint on the API Client you created in the ISU setup.
    If the client is behind a proxy server, specify
    wd.host=<proxy host>
    .
    wd.port
    443
    443
  2. Install the Python library (wheel file) using the following command:
    pip3 install <wheel.whl>
  3. Create a Python script that loads the configuration from the
    dataservice.properties
    file, creates a connection to the service, and executes the query.
    Example:
    from workday_ldq import DataServiceConfig, create_connection # Load configuration from current directory config = DataServiceConfig.from_file("dataservice.properties") # Create connection connection = create_connection(config) # Execute the Query cursor = connection.cursor() cursor.execute("SELECT * FROM {tablename} LIMIT 10") results = cursor.fetchall() cursor.close() connection.close()
dataservice.properties Sample Code
ISU Authentication
User-As-Self Authentication
wd.authn.authModel=JWT_BEARER wd.authn.clientId=your_client_id_here wd.authn.isu=ISU_username_here wd.authn.accessTokenEndpoint=https://{HOST1}/ccx/oauth2/{TENANT}/token wd.authn.privateKeyFilePath=/Users/path/to/your/private_key.pem
wd.authn.authModel=AUTHORIZATION_CODE wd.authn.clientId=your_user_client_id_here wd.authn.clientSecret=your_client_secret_here wd.authn.accessTokenEndpoint=https://{HOST1}/ccx/oauth2/{TENANT}/token wd.authn.authorizationEndpoint=https://{HOST2}/{TENANT}/authorize wd.authn.redirectUrl=https://localhost:8888/callback