OAuth20
For an overview of the delegated authentication flow, please see this guide.
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.authn.pac4j.oauth2[0].auth-url=
Authorization endpoint of the provider.
CAS Property:
|
1 |
cas.authn.pac4j.oauth2[0].auth-url=... |
1
cas:
authn:
pac4j:
oauth2[0]:
auth-url: "..."
1
java -Dcas.authn.pac4j.oauth2[0].auth-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_AUTH_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].auth-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].id=
The client id.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].id
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].id=...
1
cas:
authn:
pac4j:
oauth2[0]:
id: "..."
1
java -Dcas.authn.pac4j.oauth2[0].id="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_ID="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].profile-url=
Profile endpoint of the provider.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].profile-url
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].profile-url=...
1
cas:
authn:
pac4j:
oauth2[0]:
profile-url: "..."
1
java -Dcas.authn.pac4j.oauth2[0].profile-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_PROFILE_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].profile-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].secret=
The client secret.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].secret
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].secret=...
1
cas:
authn:
pac4j:
oauth2[0]:
secret: "..."
1
java -Dcas.authn.pac4j.oauth2[0].secret="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_SECRET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].secret="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].token-url=
Token endpoint of the provider.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].token-url
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].token-url=...
1
cas:
authn:
pac4j:
oauth2[0]:
token-url: "..."
1
java -Dcas.authn.pac4j.oauth2[0].token-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_TOKEN_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].token-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2=
Settings that deal with having OAuth2-capable providers as an external delegated-to authentication provider.
CAS Property:
|
1 |
cas.authn.pac4j.oauth2=... |
1
cas:
authn:
pac4j:
oauth2: "..."
1
java -Dcas.authn.pac4j.oauth2="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].auto-redirect-type=NONE
Auto-redirect to this client. Available values are as follows:
-
SERVER
: Redirect on the server side, typically making CAS invisible. -
CLIENT
: Redirect on the client side using browser redirects, etc. -
NONE
: Do nothing and let the selection take place manually.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].auto-redirect-type
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].auto-redirect-type=NONE
1
cas:
authn:
pac4j:
oauth2[0]:
auto-redirect-type: "NONE"
1
java -Dcas.authn.pac4j.oauth2[0].auto-redirect-type="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_AUTO_REDIRECT_TYPE="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].auto-redirect-type="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].callback-url=
Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done. This may be used at the discretion of the client and its type to build service parameters, redirect URIs, etc. If none is specified, the CAS server's login endpoint will be used as the basis of the final callback url.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].callback-url
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].callback-url=...
1
cas:
authn:
pac4j:
oauth2[0]:
callback-url: "..."
1
java -Dcas.authn.pac4j.oauth2[0].callback-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_CALLBACK_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].callback-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].callback-url-type=QUERY_PARAMETER
Determine how the callback url should be resolved.
Default is CallbackUrlTypes#QUERY_PARAMETER
.
Available values are as follows:
-
PATH_PARAMETER
: Path parameter callback url. The client name is added to the path of the callback URL. -
QUERY_PARAMETER
: Query parameter callback url. The client name is added to the path of a query parameter. -
NONE
: No callback url. No name is added to the callback URL to be able to distinguish the client.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].callback-url-type
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].callback-url-type=QUERY_PARAMETER
1
cas:
authn:
pac4j:
oauth2[0]:
callback-url-type: "QUERY_PARAMETER"
1
java -Dcas.authn.pac4j.oauth2[0].callback-url-type="QUERY_PARAMETER" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_CALLBACK_URL_TYPE="QUERY_PARAMETER"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].callback-url-type="QUERY_PARAMETER"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].client-authentication-method=basicAuth
The client authentication method: basicAuth
(default) or requestBody
.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].client-authentication-method
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].client-authentication-method=basicAuth
1
cas:
authn:
pac4j:
oauth2[0]:
client-authentication-method: "basicAuth"
1
java -Dcas.authn.pac4j.oauth2[0].client-authentication-method="basicAuth" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_CLIENT_AUTHENTICATION_METHOD="basicAuth"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].client-authentication-method="basicAuth"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].client-name=
Name of the client mostly for UI purposes and uniqueness. This name, with 'non-word' characters converted to '-' (e.g. "This Org (New)" becomes "This-Org--New-") is added to the "class" attribute of the redirect link on the login page, to allow for custom styling of individual IdPs (e.g. for an organization logo).
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].client-name
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].client-name=...
1
cas:
authn:
pac4j:
oauth2[0]:
client-name: "..."
1
java -Dcas.authn.pac4j.oauth2[0].client-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_CLIENT_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].client-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].css-class=
CSS class that should be assigned to this client.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].css-class
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].css-class=...
1
cas:
authn:
pac4j:
oauth2[0]:
css-class: "..."
1
java -Dcas.authn.pac4j.oauth2[0].css-class="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_CSS_CLASS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].css-class="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].custom-params=
Custom parameters in form of key-value pairs sent along in authZ requests, etc.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].custom-params
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].custom-params=...
1
cas:
authn:
pac4j:
oauth2[0]:
custom-params: "..."
1
java -Dcas.authn.pac4j.oauth2[0].custom-params="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_CUSTOM_PARAMS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].custom-params="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].display-name=
Indicate the title or display name of the client for decoration and client presentation purposes. If left blank, the client original name would be used by default.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].display-name
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].display-name=...
1
cas:
authn:
pac4j:
oauth2[0]:
display-name: "..."
1
java -Dcas.authn.pac4j.oauth2[0].display-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_DISPLAY_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].display-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].enabled=true
Whether the client/external identity provider should be considered active and enabled for integration purposes.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].enabled
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].enabled=true
1
cas:
authn:
pac4j:
oauth2[0]:
enabled: "true"
1
java -Dcas.authn.pac4j.oauth2[0].enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].principal-id-attribute=
The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].principal-id-attribute
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].principal-id-attribute=...
1
cas:
authn:
pac4j:
oauth2[0]:
principal-id-attribute: "..."
1
java -Dcas.authn.pac4j.oauth2[0].principal-id-attribute="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_PRINCIPAL_ID_ATTRIBUTE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].principal-id-attribute="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].profile-attrs=
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}.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].profile-attrs
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].profile-attrs=...
1
cas:
authn:
pac4j:
oauth2[0]:
profile-attrs: "..."
1
java -Dcas.authn.pac4j.oauth2[0].profile-attrs="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_PROFILE_ATTRS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].profile-attrs="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].profile-verb=POST
Http method to use when asking for profile.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].profile-verb
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].profile-verb=POST
1
cas:
authn:
pac4j:
oauth2[0]:
profile-verb: "POST"
1
java -Dcas.authn.pac4j.oauth2[0].profile-verb="POST" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_PROFILE_VERB="POST"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].profile-verb="POST"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].response-type=code
Response type determines the authentication flow on the Authentication Server.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].response-type
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].response-type=code
1
cas:
authn:
pac4j:
oauth2[0]:
response-type: "code"
1
java -Dcas.authn.pac4j.oauth2[0].response-type="code" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_RESPONSE_TYPE="code"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].response-type="code"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].scope=
The scope requested from the identity provider.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].scope
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].scope=...
1
cas:
authn:
pac4j:
oauth2[0]:
scope: "..."
1
java -Dcas.authn.pac4j.oauth2[0].scope="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_SCOPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].scope="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.pac4j.oauth2[0].with-state=
Whether a state value should be generated when sending authentication requests to the provider.
org.apereo.cas.configuration.model.support.pac4j.oauth.Pac4jOAuth20ClientProperties.
CAS Property: cas.authn.pac4j.oauth2[].with-state
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.pac4j.oauth2[0].with-state=...
1
cas:
authn:
pac4j:
oauth2[0]:
with-state: "..."
1
java -Dcas.authn.pac4j.oauth2[0].with-state="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_PAC4J_OAUTH2[0]_WITH_STATE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.pac4j.oauth2[0].with-state="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.