OAuth client credentials for dbt State Deprecated
The standalone dbt State app (app.state.dbt.com) is no longer accepting new users. If you have an existing dbt State app account, create a free dbt platform account to continue using dbt State — your free trial will be extended upon account creation.
If you're using the standalone dbt State web app, authenticate dbt State with OAuth client credentials.
Prerequisites
- dbt State installed and configured. Refer to Set up dbt State for more information.
- A standalone dbt State account at app.state.dbt.com.
- An Admin or Owner role in your dbt State organization. Refer to Roles and tab access for details.
Roles and tab access
The dbt State web app has four tabs under Organization:
| Tab | Description |
|---|---|
| Usage | View your project reuses and compute time saved once dbt State is enabled. |
| Users | Invite team members and grant or revoke access. |
| Billing | View daily active target tables (DATTs) for the current billing period. |
| Clients | Create and manage OAuth clients for CI/CD and other non-interactive environments. |
Your role determines which tabs you can access.
| Role | Access | Notes |
|---|---|---|
| Owner | Usage, Users, Billing, Clients | The user who created the organization is the Owner by default. An Owner can transfer their role to another user, which demotes the original Owner to Admin. |
| Admin | Usage, Users, Billing, Clients | — |
| Developer | Usage | Default role when users are added. |
An existing Owner or Admin can grant or revoke admin access from the Users tab.
Creating an OAuth client
- In the dbt State web app, navigate to the Clients tab.
- Click Add OAuth Client.
- Enter a name and description for the new client and click Create.
- Copy the client ID and secret to use in your environment configuration.
Configuring OAuth authentication
Once you have the client ID and secret, set the following environment variables in your environment. Using environment variables is the recommended approach as it keeps sensitive credentials out of your code repository.
DBT_ENGINE_STATE_OAUTH_CLIENT_ID=YOUR_CLIENT_ID
DBT_ENV_SECRET_STATE_OAUTH_CLIENT_SECRET=YOUR_CLIENT_SECRET
Replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the values from your OAuth client.
Once configured, verify dbt State is active.
Related docs
Was this page helpful?
This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.
