Document all valid auth_type values in README#1121
Closed
chrisst wants to merge 7 commits into
Closed
Conversation
Explicitly list all 18 valid auth_type values in the "Additional authentication configuration options" section to improve developer experience and reduce confusion about which authentication types are supported. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
chrisst
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. |
Added the same comprehensive list of valid auth_type values to the docs/authentication.md file to ensure consistency across all documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
chrisst
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Created a new detailed reference document (docs/auth-types-reference.md) that provides: - Complete table of all 18 auth types with descriptions - Required and optional parameters for each auth type - Environment variables for all parameters - Usage examples for common auth types - Authentication priority order - Cross-references and notes Also added links from README.md and docs/authentication.md to the new reference guide for easy discoverability. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
chrisst
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
- Add auth_type parameter to all examples in auth-types-reference.md - Clarify that explicit auth_type short-circuits automatic detection - Update README.md and authentication.md to link to auth-types-reference - Add auth-types-reference to docs/index.rst toctree for readthedocs - Fix broken azure-ad.md link in README.md - Add new examples: basic, azure-cli, github-oidc-azure, azure-devops-oidc, google-id, metadata-service, runtime-oauth, env-oidc, file-oidc, model-serving
chrisst
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Co-authored-by: Isaac
…uth docs Co-authored-by: Isaac
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Author
|
Closing this PR: this repository is now a read-only mirror, and changes are applied in the internal source repository instead (see CONTRIBUTING.md). This change has been re-applied internally and will ship to this mirror with an upcoming release. |
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
1 participant
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.
Summary
auth_typevalues for the SDKdocs/authentication.mdauth_typerows, and add it to the docs toctreeMotivation
The documentation mentions the
auth_typeparameter but doesn't state which values are acceptable, which leads to confusion when configuring authentication explicitly.Valid values documented:
pat,basic,oauth-m2m,external-browser,databricks-cli,azure-client-secret,azure-cli,github-oidc,github-oidc-azure,azure-devops-oidc,google-credentials,google-id,metadata-service,runtime,runtime-oauth,model-serving,env-oidc,file-oidc.Test plan
Documentation change only — no functional changes. Content verified against the credential strategies registered in
databricks/sdk/credentials_provider.pyand the config attributes indatabricks/sdk/config.pyas of the currentmain.NO_CHANGELOG=true
🤖 Generated with Claude Code