Skip to content

Unhide auth logout and add traceability comments #4719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mihaimitrea-db merged 8 commits into from
Apr 10, 2026
Merged

Unhide auth logout and add traceability comments #4719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
84db051
Add auth logout changelog, traceability comments, and unhide command
mihaimitrea-db Mar 12, 2026
94ff659
Remove irrelevant commit ID reference
mihaimitrea-db Mar 13, 2026
085d275
Merge branch 'main' into mihaimitrea-db/auth-logout-followup
simonfaltum Mar 14, 2026
be532db
Refine auth logout help text for review feedback
mihaimitrea-db Mar 16, 2026
077cc79
Merge remote-tracking branch 'origin/main' into mihaimitrea-db/auth-l…
mihaimitrea-db Apr 10, 2026
d698961
Merge remote-tracking branch 'origin/main' into mihaimitrea-db/auth-l…
mihaimitrea-db Apr 10, 2026
b8d0e10
Unhide auth logout, improve description, and fix changelog bullet
mihaimitrea-db Apr 10, 2026
e1a37ab
Simplify shared token description in auth logout help text
mihaimitrea-db Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEXT_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
### CLI
* Auth commands now accept a profile name as a positional argument ([#4840](https://github.com/databricks/cli/pull/4840))

* Add `auth logout` command for clearing cached OAuth tokens and optionally removing profiles ([#4613](https://github.com/databricks/cli/pull/4613), [#4616](https://github.com/databricks/cli/pull/4616), [#4647](https://github.com/databricks/cli/pull/4647))

### Bundles
* Added support for lifecycle.started option for apps ([#4672](https://github.com/databricks/cli/pull/4672))

Expand Down
38 changes: 25 additions & 13 deletions cmd/auth/logout.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
// The auth logout command was implemented across three stacked PRs that were
// inadvertently squashed into a single commit cb3c326 (titled after #4647 only):
//
// - #4613: core logout command with --profile, --auto-approve (originally --force),
// --delete flags, token cache cleanup, and DeleteProfile in libs/databrickscfg/ops.go.
// https://github.com/databricks/cli/pull/4613
//
// - #4616: interactive profile picker when --profile is
// omitted in an interactive terminal.
// https://github.com/databricks/cli/pull/4616
//
// - #4647: extract shared SelectProfile helper, deduplicate
// profile pickers across auth logout, auth token, cmd/root/auth.go, cmd/root/bundle.go.
// https://github.com/databricks/cli/pull/4647

package auth

import (
Expand Down Expand Up @@ -29,24 +44,23 @@ You will need to run {{ "databricks auth login" | bold }} to re-authenticate.

func newLogoutCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "logout [PROFILE]",
Short: "Log out of a Databricks profile",
Args: cobra.MaximumNArgs(1),
Hidden: true,
Use: "logout [PROFILE]",
Short: "Log out of a Databricks profile",
Args: cobra.MaximumNArgs(1),
Long: `Log out of a Databricks profile.

This command clears any cached OAuth tokens for the specified profile so
that the next CLI invocation requires re-authentication. The profile
entry in ~/.databrickscfg is left intact unless --delete is also specified.

This only affects profiles created with "databricks auth login". Profiles
using other authentication methods (personal access tokens, M2M credentials)
do not store cached OAuth tokens. If multiple profiles share the same cached
token, logging out of one does not affect the others.

You can provide a profile name as a positional argument, or use --profile
to specify it explicitly.

This command requires a profile to be specified or an interactive terminal.
If you omit the profile and run in an interactive terminal, you'll be shown
a profile picker. In a non-interactive environment (e.g. CI/CD), omitting
the profile is an error.

1. If you specify a profile (via argument or --profile), the command logs
out of that profile. In an interactive terminal you'll be asked to
confirm unless --auto-approve is set.
Expand All @@ -60,10 +74,8 @@ the profile is an error.
pipeline), the command will fail with an error asking you to specify
a profile.

4. Use --auto-approve to skip the confirmation prompt. This is required when
running in non-interactive environments.

5. Use --delete to also remove the selected profile from ~/.databrickscfg.`,
4. Use --delete to also remove the selected profile from the configuration
file.`,
}

var autoApprove bool
Expand Down
Loading