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

ProtectedResourceMetadata

@ExperimentalKtorApi

class ProtectedResourceMetadata(val resource: String, val authorizationServers: List<String>? = null, val jwksUri: String? = null, val scopesSupported: List<String>? = null, val bearerMethodsSupported: List<String>? = null, val resourceSigningAlgValuesSupported: List<String>? = null, val resourceName: String? = null, val resourceDocumentation: String? = null, val resourcePolicyUri: String? = null, val resourceTosUri: String? = null, val tlsClientCertificateBoundAccessTokens: Boolean? = null, val authorizationDetailsTypesSupported: List<String>? = null, val dpopSigningAlgValuesSupported: List<String>? = null, val dpopBoundAccessTokensRequired: Boolean? = null)(source)

OAuth 2.0 Protected Resource Metadata as defined in RFC 9728.

Served at the /.well-known/oauth-protected-resource endpoint when OidcPluginConfig.protectedResource is configured.

Report a problem

Constructors

ProtectedResourceMetadata

constructor(resource: String, authorizationServers: List<String>? = null, jwksUri: String? = null, scopesSupported: List<String>? = null, bearerMethodsSupported: List<String>? = null, resourceSigningAlgValuesSupported: List<String>? = null, resourceName: String? = null, resourceDocumentation: String? = null, resourcePolicyUri: String? = null, resourceTosUri: String? = null, tlsClientCertificateBoundAccessTokens: Boolean? = null, authorizationDetailsTypesSupported: List<String>? = null, dpopSigningAlgValuesSupported: List<String>? = null, dpopBoundAccessTokensRequired: Boolean? = null)

Properties

authorizationDetailsTypesSupported

@SerialName(value = "authorization_details_types_supported")

val authorizationDetailsTypesSupported: List<String>?

Authorization details types supported per RFC 9396.

authorizationServers

@SerialName(value = "authorization_servers")

val authorizationServers: List<String>?

OAuth authorization server issuer identifiers trusted by this resource.

bearerMethodsSupported

@SerialName(value = "bearer_methods_supported")

val bearerMethodsSupported: List<String>?

Methods supported for presenting Bearer tokens: header, body, query.

dpopBoundAccessTokensRequired

@SerialName(value = "dpop_bound_access_tokens_required")

val dpopBoundAccessTokensRequired: Boolean?

Whether DPoP-bound access tokens are required.

dpopSigningAlgValuesSupported

@SerialName(value = "dpop_signing_alg_values_supported")

val dpopSigningAlgValuesSupported: List<String>?

JWS algorithms supported for DPoP proof validation.

@SerialName(value = "jwks_uri")

val jwksUri: String?

URL of the resource server's JWK Set document containing its public keys.

val resource: String

The protected resource's identifier URL.

resourceDocumentation

@SerialName(value = "resource_documentation")

val resourceDocumentation: String?

URL of developer documentation for this resource.

@SerialName(value = "resource_name")

val resourceName: String?

Human-readable name of the protected resource.

resourcePolicyUri

@SerialName(value = "resource_policy_uri")

val resourcePolicyUri: String?

URL describing the resource's data usage requirements.

resourceSigningAlgValuesSupported

@SerialName(value = "resource_signing_alg_values_supported")

val resourceSigningAlgValuesSupported: List<String>?

JWS algorithms supported by this resource, excluding none.

@SerialName(value = "resource_tos_uri")

val resourceTosUri: String?

URL of the resource's terms of service.

scopesSupported

@SerialName(value = "scopes_supported")

val scopesSupported: List<String>?

OAuth 2.0 scope values that this resource server understands.

tlsClientCertificateBoundAccessTokens

@SerialName(value = "tls_client_certificate_bound_access_tokens")

val tlsClientCertificateBoundAccessTokens: Boolean?

Whether this resource requires TLS client certificate-bound access tokens.