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

OAuth2

data class OAuth2(val flows: AuthScheme.OAuth2.Flows, val issuerUrl: String? = null, val description: String? = null) : AuthScheme

An OAuth2 scheme: the flows the service supports, with their endpoints and scopes.

Constructors

OAuth2

constructor(flows: AuthScheme.OAuth2.Flows, issuerUrl: String? = null, description: String? = null)

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

Flow

@ExperimentalAuthApi

sealed interface Flow

An OAuth2 flow: its endpoints and the scopes to request.

Flows

@ExperimentalAuthApi

data class Flows(val implicit: AuthScheme.OAuth2.Flow.Implicit? = null, val password: AuthScheme.OAuth2.Flow.Password? = null, val clientCredentials: AuthScheme.OAuth2.Flow.ClientCredentials? = null, val authorizationCode: AuthScheme.OAuth2.Flow.AuthorizationCode? = null)

The OAuth2 flows a service supports. Each property is set when the service supports that flow.

Properties

description

val description: String?

A description of the scheme.

flows

val flows: AuthScheme.OAuth2.Flows

The OAuth2 flows the service supports.

issuerUrl

val issuerUrl: String?

The authorization server's issuer URL, from which its endpoints can be discovered.

type

open override val type: String

The scheme's OpenAPI type, such as apiKey or http.

Functions

toBuilder

fun toBuilder(): AuthScheme.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.