openid-data-classes/at.asitplus.openid/TokenIntrospectionResponse

TokenIntrospectionResponse

@Serializable

data class TokenIntrospectionResponse(val active: Boolean, val scope: String? = null, val clientId: String? = null, val username: String? = null, val tokenType: String? = null, val expiration: Instant? = null, val issuedAt: Instant? = null, val notBefore: Instant? = null, val subject: String? = null, val audience: Set<String>? = null, val issuer: String? = null, val jwtId: String? = null, val authorizationDetails: Set<AuthorizationDetails>? = null, val confirmationClaim: ConfirmationClaim? = null) : TokenIntrospectionResult(source)

Constructors

constructor(active: Boolean, scope: String? = null, clientId: String? = null, username: String? = null, tokenType: String? = null, expiration: Instant? = null, issuedAt: Instant? = null, notBefore: Instant? = null, subject: String? = null, audience: Set<String>? = null, issuer: String? = null, jwtId: String? = null, authorizationDetails: Set<AuthorizationDetails>? = null, confirmationClaim: ConfirmationClaim? = null)

Properties

active

@SerialName(value = "active")

val active: Boolean

REQUIRED. Boolean indicator of whether or not the presented token is currently active. The specifics of a token's "active" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a "true" value return for the "active" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time).

audience

@SerialName(value = "aud")

@Serializable(with = JwtAudienceSerializer::class)

val audience: Set<String>?

OPTIONAL. Service-specific string identifier or list of string identifiers representing the intended audience for this token, as defined in JWT RFC7519.

authorizationDetails

@SerialName(value = "authorization_details")

val authorizationDetails: Set<AuthorizationDetails>?

clientId

@SerialName(value = "client_id")

val clientId: String?

OPTIONAL. Client identifier for the OAuth 2.0 client that requested this token.

confirmationClaim

@SerialName(value = "cnf")

val confirmationClaim: ConfirmationClaim?

OPTIONAL. Confirmation of the key the token is bound to (RFC 7800 3.1), for a DPoP-bound token the JWK SHA-256 thumbprint of the DPoP key in jkt (RFC 9449 6.2). A resource server MUST check that the DPoP proof of the request is signed with that key (RFC 9449 7.1).

expiration

@SerialName(value = "exp")

@Serializable(with = InstantLongSerializer::class)

val expiration: Instant?

OPTIONAL.Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire, as defined in JWT RFC7519.

issuedAt

@SerialName(value = "iat")

@Serializable(with = InstantLongSerializer::class)

val issuedAt: Instant?

OPTIONAL. Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued, as defined in JWT RFC7519.

issuer

@SerialName(value = "iss")

val issuer: String?

OPTIONAL. String representing the issuer of this token, as defined in JWT RFC7519.

jwtId

@SerialName(value = "jti")

val jwtId: String?

OPTIONAL. String identifier for the token, as defined in JWT RFC7519.

notBefore

@SerialName(value = "nbf")

@Serializable(with = InstantLongSerializer::class)

val notBefore: Instant?

OPTIONAL. Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before, as defined in JWT RFC7519.

scope

@SerialName(value = "scope")

val scope: String?

OPTIONAL. A JSON string containing a space-separated list of scopes associated with this token, in the format described in Section 3.3 of OAuth 2.0 RFC6749.

subject

@SerialName(value = "sub")

val subject: String?

OPTIONAL. Subject of the token, as defined in JWT RFC7519. Usually a machine-readable identifier of the resource owner who authorized this token.

tokenType

@SerialName(value = "token_type")

val tokenType: String?

OPTIONAL. Type of the token as defined in Section 5.1 of OAuth 2.0 RFC6749.

username

@SerialName(value = "username")

val username: String?

OPTIONAL. Human-readable identifier for the resource owner who authorized this token.