Configure authentication to Workiva

Beta

This feature is in Beta. To use it, a workspace admin must turn on Lakeflow Connect for Workiva from the Previews page. See Manage Databricks previews.

This page shows how to obtain the credentials that enable authentication to Workiva from Databricks. The Workiva connector uses OAuth2 client credentials (a client ID and client secret) to ingest data into Databricks. Use the authentication details that you retrieve from the steps on this page to create a Unity Catalog connection in Databricks.

Prerequisites

• A Workiva organization.
• Administrator access to the Workiva organization to create an OAuth2 application and grant scopes.

Create a Workiva OAuth2 application

The connector authenticates using the OAuth2 client credentials grant. Create an OAuth2 application in Workiva to obtain a client ID and client secret.

1. Sign in to Workiva as an administrator.
2. Go to your organization's developer or API settings and create a new OAuth2 application for machine-to-machine (server-to-server) access.
3. Grant the application the following scopes:
   • activity:read — required for the activities audit-log table.
   • organization:read — required for the users and roles tables.
4. Save the application, then copy the generated Client ID and Client Secret.

You enter these values as the Client ID and Client Secret when you create a connection in Databricks.

important

Store the client secret securely. Workiva shows the secret only once when you create the application.

Find your organization ID

You must also have your Workiva organization ID. The connector uses it to scope API requests to your organization. You enter this value as the Organization ID when you create a connection in Databricks.

Find your organization ID in your Workiva organization's admin or settings page. If you are unsure, contact your Workiva administrator.

Next steps

Create a Workiva connection in Databricks. See Create a Workiva connection.