google-adk-kotlin-core/com.google.adk.kt.auth/AuthCredential/OAuth2

OAuth2

data class OAuth2(val variant: AuthCredential.OAuth2.Variant = Variant.OAUTH2, val clientId: String? = null, val clientSecret: Secret? = null, val authUri: String? = null, val nonce: String? = null, val state: String? = null, val redirectUri: String? = null, val authResponseUri: Secret? = null, val authCode: Secret? = null, val accessToken: Secret? = null, val refreshToken: Secret? = null, val idToken: Secret? = null, val expiresAt: Instant? = null, val expiresIn: Duration? = null, val audience: String? = null, val prompt: String? = null, val codeVerifier: Secret? = null, val codeChallengeMethod: String? = null, val tokenEndpointAuthMethod: AuthCredential.OAuth2.TokenEndpointAuthMethod? = TokenEndpointAuthMethod.CLIENT_SECRET_BASIC) : AuthCredential

An OAuth2 or OpenID Connect credential: the client's configuration, the sign-in state and, once the user has signed in, the tokens.

Constructors

OAuth2

constructor(variant: AuthCredential.OAuth2.Variant = Variant.OAUTH2, clientId: String? = null, clientSecret: Secret? = null, authUri: String? = null, nonce: String? = null, state: String? = null, redirectUri: String? = null, authResponseUri: Secret? = null, authCode: Secret? = null, accessToken: Secret? = null, refreshToken: Secret? = null, idToken: Secret? = null, expiresAt: Instant? = null, expiresIn: Duration? = null, audience: String? = null, prompt: String? = null, codeVerifier: Secret? = null, codeChallengeMethod: String? = null, tokenEndpointAuthMethod: AuthCredential.OAuth2.TokenEndpointAuthMethod? = TokenEndpointAuthMethod.CLIENT_SECRET_BASIC)

Types

Builder

class Builder

Fluent builder for OAuth2, provided primarily for Java callers. Any property left unset falls back to the same default as the constructor.

Companion

object Companion

TokenEndpointAuthMethod

@ExperimentalAuthApi

enum TokenEndpointAuthMethod : Enum<AuthCredential.OAuth2.TokenEndpointAuthMethod>

The way an OAuth2 client authenticates to the token endpoint (RFC 7591 section 2).

Variant

@ExperimentalAuthApi

enum Variant : Enum<AuthCredential.OAuth2.Variant>

The protocol of an OAuth2 credential, OAuth2 or OpenID Connect; both carry the same fields.

Properties

accessToken

val accessToken: Secret?

The access token that authorizes the tool's calls to the service.

audience

val audience: String?

The audience to request a token for.

authCode

val authCode: Secret?

The authorization code the provider returned, which the token exchange trades for tokens.

authResponseUri

val authResponseUri: Secret?

The full redirect URL the provider returned, including the code.

authUri

val authUri: String?

Where to send the user to sign in.

clientId

val clientId: String?

The OAuth2 client ID.

clientSecret

val clientSecret: Secret?

The OAuth2 client secret; absent for a public client.

codeChallengeMethod

val codeChallengeMethod: String?

The PKCE code-challenge method; only S256 is supported.

codeVerifier

val codeVerifier: Secret?

The PKCE code verifier, sent with authCode to the token endpoint.

expiresAt

val expiresAt: Instant?

When the access token expires.

expiresIn

val expiresIn: Duration?

The access token's lifetime, as the token response gives it.

idToken

val idToken: Secret?

The OpenID Connect ID token, which identifies the signed-in user.

nonce

val nonce: String?

The nonce parameter of the authorization request, which ties the request to the user's session.

prompt

val prompt: String?

The prompt parameter of the authorization request.

redirectUri

val redirectUri: String?

Where the provider sends the user after signing in.

refreshToken

val refreshToken: Secret?

The refresh token, which gets a new access token when accessToken expires.

state

val state: String?

The state value that ties the provider's redirect to this sign-in.

tokenEndpointAuthMethod

val tokenEndpointAuthMethod: AuthCredential.OAuth2.TokenEndpointAuthMethod?

How the client authenticates to the token endpoint; null leaves the choice to the token exchange.

variant

val variant: AuthCredential.OAuth2.Variant

Whether this is an OAuth2 or an OpenID Connect credential.

Functions

expiresInSeconds

fun expiresInSeconds(): Long?

Returns expiresIn truncated to whole seconds, or null if it is unset. Java callers use it because they can't call the Duration getter.

toBuilder

fun toBuilder(): AuthCredential.OAuth2.Builder

Returns a Builder initialized with this instance's properties, primarily for Java callers. Prefer it over copy from Java: copy takes every property positionally, so its signature changes whenever a property is added.

toString

open override fun toString(): String