ktor-server-auth-oidc/io.ktor.server.auth.oidc/OidcTokenRefreshResult

OidcTokenRefreshResult

class OidcTokenRefreshResult(val accessToken: String, val refreshToken: String? = null, val expiresIn: Duration? = null, val tokenType: String, val scope: String? = null, val idToken: OidcToken.Id? = null)(source)

Token response returned by refreshToken.

Contains raw token response fields, so applications that manage their own tokens can decide how to persist, rotate, or expose token material.

Report a problem

Constructors

OidcTokenRefreshResult

constructor(accessToken: String, refreshToken: String? = null, expiresIn: Duration? = null, tokenType: String, scope: String? = null, idToken: OidcToken.Id? = null)

Properties

accessToken

val accessToken: String

Access token returned by the token endpoint.

expiresIn

val expiresIn: Duration?

Token lifetime as Duration, or null when unavailable.

idToken

val idToken: OidcToken.Id?

Verified ID-token when idToken is present, otherwise null.

refreshToken

val refreshToken: String?

Raw refresh token returned by the token endpoint, or null when the provider did not rotate or return one. Persist refreshToken when it is present; otherwise keep the refresh token used for the request.

scope

val scope: String?

Scope string returned by the token endpoint, or null when unavailable.

tokenType

val tokenType: String

Token type returned by the token endpoint.