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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apereo.cas.configuration.model.support.pac4j.Pac4jBaseClientProperties
Pac4jBaseClientProperties.CallbackUrlTypes
Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
CasFeatureModule.FeatureCatalog
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAuthorization endpoint of the provider.The client authentication method:basicAuth
(default) orrequestBody
.Custom parameters in form of key-value pairs sent along in authZ requests, etc.Profile attributes to request and collect in form of key-value pairs.Profile endpoint of the provider.Http method to use when asking for profile.Response type determines the authentication flow on the Authentication Server.getScope()
The scope requested from the identity provider.Token endpoint of the provider.boolean
Whether a state value should be generated when sending authentication requests to the provider.setAuthUrl
(String authUrl) Authorization endpoint of the provider.setClientAuthenticationMethod
(String clientAuthenticationMethod) The client authentication method:basicAuth
(default) orrequestBody
.setCustomParams
(Map<String, String> customParams) Custom parameters in form of key-value pairs sent along in authZ requests, etc.setProfileAttrs
(Map<String, String> profileAttrs) Profile attributes to request and collect in form of key-value pairs.setProfileUrl
(String profileUrl) Profile endpoint of the provider.setProfileVerb
(String profileVerb) Http method to use when asking for profile.setResponseType
(String responseType) Response type determines the authentication flow on the Authentication Server.The scope requested from the identity provider.setTokenUrl
(String tokenUrl) Token endpoint of the provider.setWithState
(boolean withState) Whether a state value should be generated when sending authentication requests to the provider.Methods inherited from class org.apereo.cas.configuration.model.support.pac4j.Pac4jIdentifiableClientProperties
getId, getSecret, setId, setSecret
Methods inherited from class org.apereo.cas.configuration.model.support.pac4j.Pac4jBaseClientProperties
getAutoRedirectType, getCallbackUrl, getCallbackUrlType, getClientName, getCssClass, getDisplayName, getPrincipalIdAttribute, isEnabled, setAutoRedirectType, setCallbackUrl, setCallbackUrlType, setClientName, setCssClass, setDisplayName, setEnabled, setPrincipalIdAttribute
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
isDefined, isUndefined
-
Constructor Details
-
Pac4jOAuth20ClientProperties
public Pac4jOAuth20ClientProperties()
-
-
Method Details
-
getAuthUrl
Authorization endpoint of the provider. -
getTokenUrl
Token endpoint of the provider. -
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
The scope requested from the identity provider. -
getProfileVerb
Http method to use when asking for profile. -
getResponseType
Response type determines the authentication flow on the Authentication Server. -
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 asCONVERTER|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 areLocale, 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
Custom parameters in form of key-value pairs sent along in authZ requests, etc. -
getClientAuthenticationMethod
The client authentication method:basicAuth
(default) orrequestBody
. -
setAuthUrl
Authorization endpoint of the provider.- Returns:
this
.
-
setTokenUrl
Token endpoint of the provider.- Returns:
this
.
-
setProfileUrl
Profile endpoint of the provider.- Returns:
this
.
-
setWithState
Whether a state value should be generated when sending authentication requests to the provider.- Returns:
this
.
-
setScope
The scope requested from the identity provider.- Returns:
this
.
-
setProfileVerb
Http method to use when asking for profile.- Returns:
this
.
-
setResponseType
Response type determines the authentication flow on the Authentication Server.- Returns:
this
.
-
setProfileAttrs
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 asCONVERTER|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 areLocale, 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
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) orrequestBody
.- Returns:
this
.
-