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

TokenIntrospection

@ExperimentalKtorApi

class TokenIntrospection(val active: Boolean, val scope: String? = null, val clientId: String? = null, val username: String? = null, val tokenType: String? = null, val expiresAt: Long? = null, val issuedAt: Long? = null, val notBefore: Long? = null, val subject: String? = null, val audience: List<String> = emptyList(), val issuer: String? = null, val jwtId: String? = null, val claims: JsonObject = JsonObject(emptyMap()))(source)

Normalized RFC 7662 token introspection response.

Report a problem

Constructors

TokenIntrospection

constructor(active: Boolean, scope: String? = null, clientId: String? = null, username: String? = null, tokenType: String? = null, expiresAt: Long? = null, issuedAt: Long? = null, notBefore: Long? = null, subject: String? = null, audience: List<String> = emptyList(), issuer: String? = null, jwtId: String? = null, claims: JsonObject = JsonObject(emptyMap()))

Properties

val active: Boolean

whether the token is currently active.

@SerialName(value = "aud")

val audience: List<String>

normalized token audiences. String audiences are preserved as a single value.

val claims: JsonObject

raw JSON claims returned by the introspection endpoint.

@SerialName(value = "client_id")

val clientId: String?

client identifier associated with the token.

@SerialName(value = "exp")

val expiresAt: Long?

expiration time as seconds since the Unix epoch.

@SerialName(value = "iat")

val issuedAt: Long?

issuance time as seconds since the Unix epoch.

@SerialName(value = "iss")

val issuer: String?

token issuer.

@SerialName(value = "jti")

val jwtId: String?

token identifier.

@SerialName(value = "nbf")

val notBefore: Long?

not-before time as seconds since the Unix epoch.

val scope: String?

OAuth scope string returned by the introspection endpoint.

@SerialName(value = "sub")

val subject: String?

subject identifier associated with the token.

@SerialName(value = "token_type")

val tokenType: String?

token type, such as Bearer.

val username: String?

resource owner username, when returned by the authorization server.