Apache Syncope Attribute Resolution

The following configuration describes how to fetch and retrieve attributes from Apache Syncope.

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

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

cas.authn.attribute-repository.syncope.basic-auth-password=

Specify the password for REST authentication.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

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

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.basic-auth-password=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        basic-auth-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.basic-auth-password="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_BASIC_AUTH_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.basic-auth-password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.basic-auth-username=

Specify the username for REST authentication.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.basic-auth-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        basic-auth-username: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.basic-auth-username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_BASIC_AUTH_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.basic-auth-username="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.domain=Master

Syncope domain used for authentication, etc. Multiple domains can be separated via comma. Each domain entry results in a separate authentication attempt and transaction by CAS.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.domain=Master

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        domain: "Master"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.domain="Master" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_DOMAIN="Master"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.domain="Master"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.search-filter=

User FIQL filter to use for searching. Syntax is username=={user} or username=={0}.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.search-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        search-filter: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.search-filter="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_SEARCH_FILTER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.search-filter="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.url=

Syncope instance URL primary used for REST.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your
configuration if you need to modify the default value.}

cas.authn.attribute-repository.syncope.attribute-mappings=

Map of attributes that optionally may be used to control the names of the collected attributes from Syncope. If an attribute is provided by Syncope, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention lastLoginDate->lastDate will process the Syncope attribute lastLoginDate and will internally rename that to lastDate. If no mapping is specified, CAS defaults will be used instead.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.attribute-mappings=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        attribute-mappings: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.attribute-mappings="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_ATTRIBUTE_MAPPINGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.attribute-mappings="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.headers=

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.headers=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        headers: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.headers="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_HEADERS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.headers="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.id=

A value can be assigned to this field to uniquely identify this resolver.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.attribute-repository.syncope.id=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      syncope: 
        id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.attribute-repository.syncope.id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_ATTRIBUTE_REPOSITORY_SYNCOPE_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.attribute-repository.syncope.id="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.attribute-repository.syncope.order=0

The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.

org.apereo.cas.configuration.model.support.syncope.SyncopePrincipalAttributesProperties.

_{How can I configure this property?}