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

ServiceAccount

data class ServiceAccount(val serviceAccountCredential: AuthCredential.ServiceAccount.Credential? = null, val scopes: List<String>? = null, val useDefaultCredential: Boolean = false, val useIdToken: Boolean = false, val audience: String? = null) : AuthCredential

A Google Cloud credential: a service account key, or Application Default Credentials.

Throws

IllegalArgumentException

if serviceAccountCredential is null and useDefaultCredential is false, or if useIdToken is true and audience is null or empty.

Constructors

ServiceAccount

constructor(serviceAccountCredential: AuthCredential.ServiceAccount.Credential? = null, scopes: List<String>? = null, useDefaultCredential: Boolean = false, useIdToken: Boolean = false, audience: String? = null)

Types

Builder

class Builder

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

Companion

object Companion

Credential

@ExperimentalAuthApi

data class Credential(val type: String = "", val projectId: String, val privateKeyId: Secret, val privateKey: Secret, val clientEmail: String, val clientId: String, val authUri: String, val tokenUri: String, val authProviderX509CertUrl: String, val clientX509CertUrl: String, val universeDomain: String)

A service account key, as in the JSON key file Google Cloud issues.

Properties

audience

val audience: String?

The audience of the ID token, usually the URL of the receiving service.

scopes

val scopes: List<String>?

The OAuth2 scopes to request for the access token; pass at least one with a key. With Application Default Credentials, null or empty means https://www.googleapis.com/auth/cloud-platform. ID tokens ignore them.

serviceAccountCredential

val serviceAccountCredential: AuthCredential.ServiceAccount.Credential?

The service account key; required unless useDefaultCredential is true.

useDefaultCredential

val useDefaultCredential: Boolean

Whether to use Application Default Credentials instead of a key.

useIdToken

val useIdToken: Boolean

Whether to get an ID token instead of an access token; requires a non-empty audience.

Functions

toBuilder

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