Skip to content

Custom Authentication Schemes-1 #1587 - 1 #1588

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

Open
adk-bot wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Custom Authentication Schemes-1 #1587 - 1 #1588

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d082ff
Update authentication docs for custom schemes and nonce
adk-bot Apr 9, 2026
cc4acec
Merge branch 'main' into agent-changes-20260409-200854
jcwriter74 Jun 23, 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
17 changes: 16 additions & 1 deletion docs/tools-custom/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,29 @@ specific interactive process with your ***Agent Client*** application.
not require an authentication exchange.
* **OAUTH2:** Provides standard OAuth 2.0 authentication flows, and requires
configuration with client ID, secret, and scopes. This method often
triggers an interactive flow for user consent.
triggers an interactive flow for user consent. `OAuth2Auth` also now
includes a `nonce` field, which can be used to securely bind the user's
session to the authorization request during OIDC flows.
* **OPEN\_ID\_CONNECT:** Provides authentication based on OpenID Connect.
Similar to OAuth2, this type often requires configuration and user
interaction.
* **SERVICE\_ACCOUNT:** Provides Google Cloud Service Account credentials as a
JSON key or Application Default Credentials. This type typically exchanges a
Bearer token.

### Custom authentication schemes

In addition to the standard OpenAPI authentication schemes, you can define
your own custom authentication schemes by subclassing `CustomAuthScheme`.
This is useful for integrating with proprietary or legacy authentication systems
that don't follow OpenAPI standards. When subclassing, ensure that the `type_`
field has a default value.

To simplify registration of custom authentication providers, you can define a
`supported_auth_schemes` property on your `BaseAuthProvider` implementation.
This property should return a tuple of the custom scheme types your provider
supports.

## Tools and integrations quick guide

Here is a quick guide to authentication for key ADK toolsets:
Expand Down
Loading