Package io.micronaut.security.oauth2.client

Interface OpenIdClient

All Superinterfaces:
OauthClient
All Known Implementing Classes:
DefaultOpenIdClient
public interface OpenIdClient extends OauthClient
Extends the OauthClient with OpenID specific functionality.
Since:
1.2.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<io.micronaut.http.MutableHttpResponse<?>>
    endSessionRedirect(io.micronaut.http.HttpRequest<?> request, io.micronaut.security.authentication.Authentication authentication)
    Redirects to the end session endpoint of an OpenID provider.
    boolean
    supportsEndSession()
     

    Methods inherited from interface io.micronaut.security.oauth2.client.OauthClient

    authorizationRedirect, getName, onCallback

  • Method Details

    • supportsEndSession

      boolean supportsEndSession()
      Returns:
      True if this client supports end session

    • endSessionRedirect

      Optional<io.micronaut.http.MutableHttpResponse<?>> endSessionRedirect(io.micronaut.http.HttpRequest<?> request, io.micronaut.security.authentication.Authentication authentication)
      Redirects to the end session endpoint of an OpenID provider. Returns an empty optional if the provider does not support end session or an EndSessionEndpoint could not be resolved for the provider.
      Parameters:
      request - The current request
      authentication - The current authentication
      Returns:
      An optional response