Allow the use of different client IDs in U2M auth - #6594
Merged
Merged
Conversation
Collaborator
Integration test reportCommit: 7cd98de
Top 6 slowest tests (at least 2 minutes):
|
renaudhartert-db
enabled auto-merge
September 10, 2026 16:23
mihaimitrea-db
left a comment
Contributor
There was a problem hiding this comment.
Have a look at the comment
Comment on lines
+115
to
+118
| clientIDConfig, ok := cfg.GetAuthDetails().Configuration["client_id"] | ||
| if ok && clientIDConfig.Source.Type == config.SourceFile { | ||
| opts = append(opts, u2m.WithClientID(cfg.ClientID)) | ||
| } |
Contributor
There was a problem hiding this comment.
[edge case] If you have a correctly setup profile using the client ID you want, but also set DATABRICKS_CLIENT_ID, this piece of code will make the CLI use its default Client ID.
This is because the cfg first resolves env variables, making this if statement here fail.
mihaimitrea-db
approved these changes
Sep 10, 2026
Collaborator
Integration test reportCommit: d1d367d
498 interesting tests: 492 FAIL, 5 KNOWN, 1 SKIP
Top 50 slowest tests (at least 2 minutes):
|
janniklasrose
pushed a commit
that referenced
this pull request
Sep 15, 2026
## Changes Allow OAuth U2M authentication to override the CLI client ID through profile `client_id` or `DATABRICKS_CLIENT_ID`, and add `databricks auth login --client-id`. The flag overrides an existing profile value and persists the effective client ID for login, token refresh, and discovery login. The U2M credential strategy accepts the resolved client ID regardless of whether it came from the profile, environment, or dynamic configuration. The override remains restricted to the `databricks-cli` auth type so M2M credentials do not leak into U2M. ## Why Organizations may need the CLI U2M flow to authenticate through a custom OAuth application while keeping the override scoped to an explicit login, profile, or environment. ## Tests - Full Go lint: zero issues - Full unit suite: 10,032 tests passed - Direct-host and discovery login acceptance tests, including both configured deployment engines - Focused `libs/auth` tests covering file, environment, and dynamic client ID sources - Tidy, whitespace, deadcode, changelog, lockfile, and Go formatting checks The full acceptance sweep was blocked before execution because this machine has jq 1.6 and the suite requires jq 1.7 or newer. The pinned Python formatter/linter could not be downloaded because PyPI DNS was unavailable; no Python files changed. _This PR was written by Codex._
deco-sdk-tagging Bot
added a commit
that referenced
this pull request
Sep 16, 2026
## Release v1.17.0 ### Notable Changes * Bump the direct deployment state version to 3. Clients older than v1.8.0 will reject bundles deployed with this release. ([#6713](#6713)) ### CLI * Add an `INVALID_REFRESH_TOKEN` error code to `databricks auth token --output json` failures. ([#6684](#6684)) * Add experimental `databricks auth docker configure` to configure Docker credential helper access for Databricks Artifact Registry. ([#6700](#6700)) * Add experimental `databricks auth docker token` to generate Docker credentials for Databricks Artifact Registry. ([#6699](#6699)) * `databricks environments setup-local` now reports the `E_PROVISION_CONFLICT` error code instead of the generic `E_PROVISION` when `uv sync` fails to resolve a dependency conflict. ([#6666](#6666)) * Preserve SSH sessions across temporary tunnel disconnects, with bounded replay and backpressure for large transfers. ([#6650](#6650)) * Allow OAuth U2M logins to override the CLI client ID with `--client-id`, profile `client_id`, or `DATABRICKS_CLIENT_ID`. ([#6594](#6594)) ### Bundles * direct: Store a dashboard's `serialized_dashboard` in state as a content hash instead of its full contents. ([#6105](#6105)) * direct: Fix pipelines recreation when the whole `ingestion_definition` block is added or removed. ([#6589](#6589)) * `bundle plan`, `deploy`, and `destroy` no longer report removing `permissions`, `grants`, or secret scope ACLs from a bundle as a deletion, since it leaves the resource untouched. ([#6647](#6647)) * `bundle plan` and `deploy` no longer list or count a resource that was already deleted remotely as a deletion, matching `bundle destroy`; applying still cleans up its stale state entry. ([#6675](#6675)) * Fix `bundle run` failing with `expected an int, found a string` when an unrelated resource references another resource that is not deployed. `bundle run` now resolves `${resources.*}` references only within the resource being run. ([#6690](#6690)) * Add grants support for the AI Gateway `model_service`, `mcp_service`, and `model_provider_service` resources (direct engine). ([#6635](#6635)) * Add bundle support for the AI Gateway `mcp_service` resource (direct engine). ([#6633](#6633)) * Add bundle support for the AI Gateway `model_provider_service` resource (direct engine). ([#6634](#6634)) * Add bundle support for the AI Gateway `model_service` resource (direct engine). ([#6525](#6525)) * Prevent resource drift on catalogs if `storage_root` contained a trailing slash in the URL. ([#6622](#6622)) * Fixed a "lineage mismatch in state files" error that could occur after destroying a bundle and redeploying it from another machine. `bundle destroy` now removes the local state file so no stale lineage is left behind, and prunes the state directories it leaves empty (such as `.internal/` and `sync-snapshots/`). ([#6210](#6210), [#6685](#6685)) * direct: `bundle plan` no longer reports a permanent update on a cluster that uses a cluster policy: when the cluster spec sets `policy_id`, a field present in the remote but absent from the bundle config is not treated as drift. ([#6531](#6531)) * `bundle deploy` on the direct engine now reports each resource as soon as it is deployed, instead of listing them all after the deployment finishes. A deploy that fails part way through now reports the resources it did apply. ([#6361](#6361)) * Direct-engine bundles no longer flag phantom drift on server-populated nested fields under reused config types (e.g. `external_locations` file-event-queue resource IDs, `database_instances` parent-instance refs, `apps` git credential ID). ([#6618](#6618)) * `databricks bundle generate app` now reproduces a git-backed app's `git_repository` and `git_source` configuration instead of emitting a workspace `source_code_path`, so generating from a Git-deployed app no longer silently converts it to workspace source. ([#6656](#6656)) * Improved configuration load time for bundles with many included files. ([#6195](#6195)) * `bundle destroy` no longer deletes triggered job runs, leaving them untouched on the backend. ([#6672](#6672)) * direct: resources.job\_runs: new lifecycle.triggers.on\_file\_change setting to restart the run when monitored files change. Can be set to a series of paths or globs. ([#6309](#6309)) * Bundle summary now shows a name for Postgres branches, endpoints, databases, and roles instead of a blank Name field. ([#6663](#6663)) * Added PyDABs (Python) support for cluster policies, dashboards, and Genie spaces. ([#6585](#6585)) * CLI commands no longer imply that a resource whose type has no workspace URL is merely not deployed yet. ([#6583](#6583)) * Capture the implicit dependency a vector search index has on a catalog or schema defined in the same bundle, so the catalog and schema are deployed first. ([#6655](#6655)) ### Dependency Updates * Bump dependencies with known vulnerabilities. ([#6695](#6695)) * Bump `github.com/databricks/databricks-sdk-go` from v0.177.0 to v0.178.0. ([#6673](#6673)) * Bump Terraform provider from v1.131.0 to v1.132.0. ([#6671](#6671))
lilly-luo
added a commit
to databricks/unity-gateway
that referenced
this pull request
Sep 17, 2026
## Summary - retrieve custom OAuth tokens through `databricks auth token` when `ENABLE_CUSTOM_OAUTH_FROM_CLI=1` - pass the configured custom client ID through `DATABRICKS_CLIENT_ID` and preserve `--force-refresh` - require Databricks CLI v1.17.0 only for the gated path; keep the existing SDK flow unchanged otherwise ## Testing - `UV_CACHE_DIR=/tmp/uv-cache uv run pytest tests/test_custom_oauth.py -q` - `UV_CACHE_DIR=/tmp/uv-cache uv run ruff check src/ucode/custom_oauth.py tests/test_custom_oauth.py` ## Version note PR databricks/cli#6594 is included in Databricks CLI v1.17.0. The requested v0.17.0 predates this feature, so this change uses v1.17.0 as the feature-specific minimum. ``` "apiKeyHelper": "/tmp/unity-gateway-custom-oauth/.venv/bin/ug auth-token --profile devtools-prod --client-id 4f7af981-8977-4042-b90e-a5dea5b62e19", ``` --------- Co-authored-by: Lilly <[email protected]>
Vivek1106-04
pushed a commit
to Vivek1106-04/cli
that referenced
this pull request
Sep 23, 2026
…ks#6763) > Supersedes databricks#6621 — identical change, moved to an **in-repo branch** so the integration tests run with secrets (a fork PR can't access them). databricks#6621 was approved by @renaudhartert-db; this one needs a fresh approval. ## Changes Add a repeatable `--resource` flag to `databricks auth login` that sends [RFC 8707](https://datatracker.ietf.org/doc/html/rfc8707) resource indicator(s) as `resource` query parameters on the OAuth **authorization** request. Threaded through `u2m.PersistentAuth` via a new `WithResources` option, appended to the authorization endpoint URL (preserving any query the endpoint already carries; the `oauth2` library appends `client_id`/PKCE/etc. after). Requires `--host` (added to the discovery-incompatible flag list), since a resource indicator targets a specific workspace's `/oidc`. Example: ``` databricks auth login \ --host https://<workspace> \ --client-id <app> \ --resource https://<workspace>/ai-gateway/mcp-services/system.ai.github ``` produces: ``` https://<workspace>/oidc/v1/authorize?resource=https%3A%2F%2F<workspace>%2Fai-gateway%2Fmcp-services%2Fsystem.ai.github&client_id=<app>&code_challenge=...&redirect_uri=http%3A%2F%2Flocalhost%3A8020&response_type=code&scope=offline_access+all-apis&state=... ``` ## Why Builds on databricks#6594 (`--client-id`). A resource-aware authorization server can use the `resource` indicator to scope the login to a specific protected resource and drive **that resource's own login** before issuing the authorization code — e.g. a per-user connection credential behind an AI Gateway MCP service (`system.ai.github`), where the user must complete a downstream SaaS login the first time. Without the indicator the authorization server only sees `client_id` + user, not which connection the flow is for. This is a **draft / POC** to enable end-to-end validation of that flow; the resource indicator is currently sent on the authorization request only (not the token exchange). ## Tests - `TestPersistentAuthResources` — none / single / multiple `resource` params appear on the built authorize URL. - `TestValidateDiscoveryFlagCompatibility` — `--resource` requires `--host`. - `go test ./libs/auth/u2m/ ./cmd/auth/` pass; `go vet` clean; `gofmt` clean. _This pull request and its description were written by Isaac._ ## Update since the initial review on databricks#6621 Per @renaudhartert-db's review, the requested resources are now **persisted to the `resources` profile key**, so `databricks auth token` and a re-run of `auth login` without `--resource` reuse them, and the token cache refreshes when they change. It's a CLI-only profile key written via a dedicated helper (no `databricks-sdk-go` change). Added tests: `TestLoadProfilesResources`, `TestU2MResourcesFromProfile`, `TestSaveResourcesToProfile`. Co-authored-by: Isaac <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Allow OAuth U2M authentication to override the CLI client ID through profile
client_idorDATABRICKS_CLIENT_ID, and adddatabricks auth login --client-id. The flag overrides an existing profile value and persists the effective client ID for login, token refresh, and discovery login.The U2M credential strategy accepts the resolved client ID regardless of whether it came from the profile, environment, or dynamic configuration. The override remains restricted to the
databricks-cliauth type so M2M credentials do not leak into U2M.Why
Organizations may need the CLI U2M flow to authenticate through a custom OAuth application while keeping the override scoped to an explicit login, profile, or environment.
Tests
libs/authtests covering file, environment, and dynamic client ID sourcesThe full acceptance sweep was blocked before execution because this machine has jq 1.6 and the suite requires jq 1.7 or newer. The pinned Python formatter/linter could not be downloaded because PyPI DNS was unavailable; no Python files changed.
This PR was written by Codex.