Interface OpenIdClientConfiguration

All Superinterfaces:

io.micronaut.core.naming.Named

All Known Implementing Classes:

OauthClientConfigurationProperties.OpenIdClientConfigurationProperties

public interface OpenIdClientConfiguration
extends io.micronaut.core.naming.Named

Configuration for an OpenID client.

Since:

1.2.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final Boolean	DEFAULT_PROTECTED_RESOURCE_METADATA

Method Summary

Modifier and Type	Method	Description
Optional<AuthorizationEndpointConfiguration>	getAuthorization()
String	getConfigurationPath()
@NonNull EndSessionEndpointConfiguration	getEndSession()
Optional<URL>	getIssuer()
default Optional<String>	getIssuerIdentifier()	The value expected in the iss claim of ID tokens, if it differs from the URL used to fetch the discovery document (for example, when discovery is fetched over an internal URL but the provider issues tokens with its public URL).
Optional<String>	getJwksUri()
Optional<EndpointConfiguration>	getRegistration()
Optional<TokenEndpointConfiguration>	getToken()
Optional<EndpointConfiguration>	getUserInfo()
default boolean	isFetchConfiguration()
default boolean	isProtectedResourceMetadata()

Methods inherited from interface io.micronaut.core.naming.Named

getName

Field Details

DEFAULT_PROTECTED_RESOURCE_METADATA

static final Boolean DEFAULT_PROTECTED_RESOURCE_METADATA

Method Details

isFetchConfiguration

default boolean isFetchConfiguration()

Returns:

Whether the OpenID configuration should be fetched from the discovery endpoint derived from getIssuer() and getConfigurationPath().

Since:

5.3.0

getIssuer

Optional<URL> getIssuer()

Returns:

URL that the OpenID provider asserts as its issuer identifier.

getIssuerIdentifier

default Optional<String> getIssuerIdentifier()

The value expected in the iss claim of ID tokens, if it differs from the URL used to fetch the discovery document (for example, when discovery is fetched over an internal URL but the provider issues tokens with its public URL). Defaults to getIssuer().

Returns:

The expected issuer identifier.

Since:

5.5.2

getConfigurationPath

String getConfigurationPath()

Returns:

The OpenID configuration path

getJwksUri

Optional<String> getJwksUri()

Returns:

The JWKS configuration

getRegistration

Optional<EndpointConfiguration> getRegistration()

Returns:

The registration endpoint configuration

See Also:

• RFC 7591 - Section 3.1
• OpenID Connect Client Registration

getUserInfo

Optional<EndpointConfiguration> getUserInfo()

Returns:

The user info endpoint configuration

See Also:

• OpenID Connect Core 1.0 - UserInfo

getAuthorization

Optional<AuthorizationEndpointConfiguration> getAuthorization()

Returns:

The authorization endpoint configuration

See Also:

• RFC 6749 - Section 3.1
• OpenID Connect Core 1.0 - Authorization Endpoint

getToken

Optional<TokenEndpointConfiguration> getToken()

Returns:

The token endpoint configuration

See Also:

• RFC 6749 - Section 4.1.3
• OpenID Connect Core 1.0

getEndSession

@NonNull EndSessionEndpointConfiguration getEndSession()

Returns:

The end session configuration

See Also:

• OpenID Connect Session 1.0

isProtectedResourceMetadata

default boolean isProtectedResourceMetadata()

Returns:

whether the protected resource metadata endpoint should expose the OpenID issuer as an authorization server.

Since:

4.14.0