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

ProtectedResourceMetadataConfig

class ProtectedResourceMetadataConfig(source)

Configuration for OAuth 2.0 Protected Resource Metadata (RFC 9728).

Fields that can be auto-derived from provider configuration, such as authorizationServers, scopesSupported, and bearerMethodsSupported, are populated automatically unless explicitly overridden.

Report a problem

Parameters

resource

The protected resource's identifier URL. It must be an HTTPS URL with a host, no userinfo, no query, and no fragment.

Properties

authorizationDetailsTypesSupported

var authorizationDetailsTypesSupported: List<String>?

Authorization details types supported per RFC 9396.

authorizationServers

var authorizationServers: List<String>?

OAuth authorization server issuer identifiers trusted by this resource.

bearerMethodsSupported

var bearerMethodsSupported: List<String>?

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

dpopBoundAccessTokensRequired

var dpopBoundAccessTokensRequired: Boolean?

Whether this resource requires DPoP-bound access tokens.

dpopSigningAlgValuesSupported

var dpopSigningAlgValuesSupported: List<String>?

JWS algorithms supported for DPoP proof validation.

jwksUri

var jwksUri: String?

URL of the resource server's JWK Set document.

resource

val resource: String

resourceDocumentation

var resourceDocumentation: String?

URL of developer documentation for this resource.

resourceName

var resourceName: String?

Human-readable name of the protected resource.

resourcePolicyUri

var resourcePolicyUri: String?

URL describing the resource's data usage requirements.

resourceSigningAlgValuesSupported

var resourceSigningAlgValuesSupported: List<String>?

JWS algorithms supported by this resource server, excluding none.

resourceTosUri

var resourceTosUri: String?

URL of the resource's terms of service.

scopesSupported

var scopesSupported: List<String>?

OAuth 2.0 scope values that this resource server understands.

tlsClientCertificateBoundAccessTokens

var tlsClientCertificateBoundAccessTokens: Boolean?

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