Package org.apereo.cas.configuration.model.support.pac4j.oauth

Class Pac4jOAuth20ClientProperties

java.lang.Object
org.apereo.cas.configuration.model.support.pac4j.Pac4jBaseClientProperties
org.apereo.cas.configuration.model.support.pac4j.Pac4jIdentifiableClientProperties
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties
All Implemented Interfaces:
Serializable, CasFeatureModule
@RequiresModule(name="cas-server-support-pac4j-webflow") public class Pac4jOAuth20ClientProperties extends Pac4jIdentifiableClientProperties
This is Pac4jOAuth20ClientProperties.
Since:
5.2.0
See Also:

  • Constructor Details

    • Pac4jOAuth20ClientProperties

      public Pac4jOAuth20ClientProperties()

  • Method Details

    • getAuthUrl

      public String getAuthUrl()
      Authorization endpoint of the provider.

    • getTokenUrl

      public String getTokenUrl()
      Token endpoint of the provider.

    • getProfileUrl

      public String getProfileUrl()
      Profile endpoint of the provider.

    • isWithState

      public boolean isWithState()
      Whether a state value should be generated when sending authentication requests to the provider.

    • getScope

      public String getScope()
      The scope requested from the identity provider.

    • getProfileVerb

      public String getProfileVerb()
      Http method to use when asking for profile.

    • getResponseType

      public String getResponseType()
      Response type determines the authentication flow on the Authentication Server.

    • getProfileAttrs

      public Map<String,String> getProfileAttrs()
      Profile attributes to request and collect in form of key-value pairs. Key is the attribute name, and value is the mapped attribute name, if necessary. If remapping is not required, key and value should match. It's also possible to define values as CONVERTER|mapped-attribute. CONVERTER should be the attribute converter specified by its acceptable type and when acceptable, the converter attempts to transform the provided attribute value. Accepted converters are Locale, Integer, Color, Date, Gender, Boolean, Long, String, Url. CAS can also provide a special attribute converter that does the transformation and conversion based on an inline groovy script. This special groovy converter can be specified using this example syntax for the value, groovy { return attribute + '-test'}|mapped-attribute.

    • getCustomParams

      public Map<String,String> getCustomParams()
      Custom parameters in form of key-value pairs sent along in authZ requests, etc.

    • getClientAuthenticationMethod

      public String getClientAuthenticationMethod()
      The client authentication method: basicAuth (default) or requestBody.

    • setAuthUrl

      public Pac4jOAuth20ClientProperties setAuthUrl(String authUrl)
      Authorization endpoint of the provider.
      Returns:
      this.

    • setTokenUrl

      public Pac4jOAuth20ClientProperties setTokenUrl(String tokenUrl)
      Token endpoint of the provider.
      Returns:
      this.

    • setProfileUrl

      public Pac4jOAuth20ClientProperties setProfileUrl(String profileUrl)
      Profile endpoint of the provider.
      Returns:
      this.

    • setWithState

      public Pac4jOAuth20ClientProperties setWithState(boolean withState)
      Whether a state value should be generated when sending authentication requests to the provider.
      Returns:
      this.

    • setScope

      public Pac4jOAuth20ClientProperties setScope(String scope)
      The scope requested from the identity provider.
      Returns:
      this.

    • setProfileVerb

      public Pac4jOAuth20ClientProperties setProfileVerb(String profileVerb)
      Http method to use when asking for profile.
      Returns:
      this.

    • setResponseType

      public Pac4jOAuth20ClientProperties setResponseType(String responseType)
      Response type determines the authentication flow on the Authentication Server.
      Returns:
      this.

    • setProfileAttrs

      public Pac4jOAuth20ClientProperties setProfileAttrs(Map<String,String> profileAttrs)
      Profile attributes to request and collect in form of key-value pairs. Key is the attribute name, and value is the mapped attribute name, if necessary. If remapping is not required, key and value should match. It's also possible to define values as CONVERTER|mapped-attribute. CONVERTER should be the attribute converter specified by its acceptable type and when acceptable, the converter attempts to transform the provided attribute value. Accepted converters are Locale, Integer, Color, Date, Gender, Boolean, Long, String, Url. CAS can also provide a special attribute converter that does the transformation and conversion based on an inline groovy script. This special groovy converter can be specified using this example syntax for the value, groovy { return attribute + '-test'}|mapped-attribute.
      Returns:
      this.

    • setCustomParams

      public Pac4jOAuth20ClientProperties setCustomParams(Map<String,String> customParams)
      Custom parameters in form of key-value pairs sent along in authZ requests, etc.
      Returns:
      this.

    • setClientAuthenticationMethod

      public Pac4jOAuth20ClientProperties setClientAuthenticationMethod(String clientAuthenticationMethod)
      The client authentication method: basicAuth (default) or requestBody.
      Returns:
      this.