Package org.springframework.security.oauth2.server.authorization.settings

Class ClientSettings

java.lang.Object
org.springframework.security.oauth2.server.authorization.settings.AbstractSettings
org.springframework.security.oauth2.server.authorization.settings.ClientSettings
All Implemented Interfaces:
Serializable
public final class ClientSettings extends AbstractSettings
A facility for client configuration settings.
Since:
7.0
See Also:

  • Method Details

    • isRequireProofKey

      public boolean isRequireProofKey()
      Returns true if the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow. The default is false.
      Returns:
      true if the client is required to provide a proof key challenge and verifier, false otherwise

    • isRequireAuthorizationConsent

      public boolean isRequireAuthorizationConsent()
      Returns true if authorization consent is required when the client requests access. The default is false.
      Returns:
      true if authorization consent is required when the client requests access, false otherwise

    • getJwkSetUrl

      public String getJwkSetUrl()
      Returns the URL for the Client's JSON Web Key Set.
      Returns:
      the URL for the Client's JSON Web Key Set

    • getTokenEndpointAuthenticationSigningAlgorithm

      public JwsAlgorithm getTokenEndpointAuthenticationSigningAlgorithm()
      Returns the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods.
      Returns:
      the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint

    • getX509CertificateSubjectDN

      public String getX509CertificateSubjectDN()
      Returns the expected subject distinguished name associated to the client X509Certificate received during client authentication when using the tls_client_auth method.
      Returns:
      the expected subject distinguished name associated to the client X509Certificate received during client authentication

    • builder

      public static ClientSettings.Builder builder()
      Constructs a new ClientSettings.Builder with the default settings.
      Returns:
      the ClientSettings.Builder

    • withSettings

      public static ClientSettings.Builder withSettings(Map<String,Object> settings)
      Constructs a new ClientSettings.Builder with the provided settings.
      Parameters:
      settings - the settings to initialize the builder
      Returns:
      the ClientSettings.Builder