APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

PayPal

For an overview of the delegated authentication flow, please see this guide.

Support is enabled by including the following dependency in the WAR overlay:



1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-pac4j-oidc</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-pac4j-oidc:${project.'cas.version'}"





1
2
3
4
5
6
7
8
9



dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-pac4j-oidc"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-pac4j-oidc"
}

Configuration

The following settings and properties are available from the CAS configuration catalog:

cas.authn.pac4j.paypal.idThe client id.
no default
RequiredSpEL

The client id.

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
Supports
Spring Expression Language
cas.authn.pac4j.paypal.secretThe client secret.
no default
RequiredSpEL

The client secret.

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
Supports
Spring Expression Language
cas.authn.pac4j.paypal.auto-redirect-typeAuto-redirect to this client.
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.
Type
DelegationAutoRedirectTypes
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.callback-urlCallback URL to use to return the flow back to the CAS server one the identity provider is successfully done.
no default

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.

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.callback-url-typeDetermine how the callback url should be resolved.
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.
Type
Pac4jBaseClientProperties.CallbackUrlTypes
Default
QUERY_PARAMETER
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.client-nameName of the client mostly for UI purposes and uniqueness.
no default

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).

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.css-classCSS class that should be assigned to this client.
no default

CSS class that should be assigned to this client.

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.display-nameIndicate the title or display name of the client for decoration and client presentation purposes.
no default

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.

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.enabledWhether the client/external identity provider should be considered active and enabled for integration purposes.
true

Whether the client/external identity provider should be considered active and enabled for integration purposes.

Type
Boolean
Default
true
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.principal-id-attributeThe attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.
no default

The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.

Type
String
Default
none
Defined by
Pac4jDelegatedAuthenticationPayPalProperties
cas.authn.pac4j.paypal.propagate-logoutIndicate whether the logout should be propagated from the CAS server to the delegated identity server.
true

Indicate whether the logout should be propagated from the CAS server to the delegated identity server.

Type
Boolean
Default
true
Defined by
Pac4jDelegatedAuthenticationPayPalProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

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: Note

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, especially 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.