LDAP Attribute Resolution

The following configuration describes how to fetch and retrieve attributes from LDAP attribute repositories.

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.ldap[0].base-dn=

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

org.apereo.cas.configuration.model.support.ldap.LdapPrincipalAttributesProperties.

_{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.ldap[0].base-dn=...

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: 
      - ldap: 
        base-dn: "..."

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.ldap[0].base-dn="..." -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_LDAP[0]_BASE_DN="..."

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.ldap[0].base-dn="..."

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.ldap[0].bind-credential=

The bind credential to use when connecting to LDAP.

org.apereo.cas.configuration.model.support.ldap.LdapPrincipalAttributesProperties.

_{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.ldap[0].bind-credential=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        bind-credential: "..."

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.ldap[0].bind-credential="..." -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_LDAP[0]_BIND_CREDENTIAL="..."

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.ldap[0].bind-credential="..."

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.ldap[0].bind-dn=

The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters:

bindDn/bindCredential provided - Use the provided credentials to bind when initializing connections.
bindDn/bindCredential set to * - Use a fast-bind strategy to initialize the pool.
bindDn/bindCredential set to blank - Skip connection initializing; perform operations anonymously.
SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections.

org.apereo.cas.configuration.model.support.ldap.LdapPrincipalAttributesProperties.

_{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.ldap[0].bind-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        bind-dn: "..."

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.ldap[0].bind-dn="..." -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_LDAP[0]_BIND_DN="..."

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.ldap[0].bind-dn="..."

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.ldap[0].ldap-url=

The LDAP url to the server. More than one may be specified, separated by space and/or comma.

org.apereo.cas.configuration.model.support.ldap.LdapPrincipalAttributesProperties.

_{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.ldap[0].ldap-url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        ldap-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.ldap[0].ldap-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_LDAP[0]_LDAP_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.ldap[0].ldap-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.

cas.authn.attribute-repository.ldap[0].search-filter=

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

You may also provide an external groovy script in the syntax of file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.

org.apereo.cas.configuration.model.support.ldap.LdapPrincipalAttributesProperties.

_{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.ldap[0].search-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        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.ldap[0].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_LDAP[0]_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.ldap[0].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.

_{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.ldap=

Retrieve attributes from multiple LDAP servers.

org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesProperties.

_{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.ldap=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      ldap: 

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.ldap="..." -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_LDAP="..."

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.ldap="..."

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.ldap[0].search-entry-handlers.case-change.attribute-name-case-change=

The Attribute name case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.case-change.attribute-name-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          case-change: 
            attribute-name-case-change: 

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.ldap[0].search-entry-handlers.case-change.attribute-name-case-change="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_CASE_CHANGE_ATTRIBUTE_NAME_CASE_CHANGE="..."

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.ldap[0].search-entry-handlers.case-change.attribute-name-case-change="..."

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.ldap[0].search-entry-handlers.case-change.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.case-change.attribute-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          case-change: 
            attribute-names: 

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.ldap[0].search-entry-handlers.case-change.attribute-names="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_CASE_CHANGE_ATTRIBUTE_NAMES="..."

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.ldap[0].search-entry-handlers.case-change.attribute-names="..."

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.ldap[0].search-entry-handlers.case-change.attribute-value-case-change=

The Attribute value case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.case-change.attribute-value-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          case-change: 
            attribute-value-case-change: 

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.ldap[0].search-entry-handlers.case-change.attribute-value-case-change="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_CASE_CHANGE_ATTRIBUTE_VALUE_CASE_CHANGE="..."

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.ldap[0].search-entry-handlers.case-change.attribute-value-case-change="..."

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.ldap[0].search-entry-handlers.case-change.dn-case-change=

The Dn case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.case-change.dn-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          case-change: 
            dn-case-change: 

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.ldap[0].search-entry-handlers.case-change.dn-case-change="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_CASE_CHANGE_DN_CASE_CHANGE="..."

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.ldap[0].search-entry-handlers.case-change.dn-case-change="..."

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.ldap[0].search-entry-handlers.dn-attribute.add-if-exists=

The Add if exists.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.dn-attribute.add-if-exists=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          dn-attribute: 
            add-if-exists: 

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.ldap[0].search-entry-handlers.dn-attribute.add-if-exists="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_DN_ATTRIBUTE_ADD_IF_EXISTS="..."

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.ldap[0].search-entry-handlers.dn-attribute.add-if-exists="..."

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.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-name=entryDN

The Dn attribute name.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-name=entryDN

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "entryDN"          dn-attribute: 
            dn-attribute-name: 

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.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-name="entryDN" -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_DN_ATTRIBUTE_DN_ATTRIBUTE_NAME="entryDN"

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.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-name="entryDN"

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.ldap[0].search-entry-handlers.merge-attribute.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.merge-attribute.attribute-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          merge-attribute: 
            attribute-names: 

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.ldap[0].search-entry-handlers.merge-attribute.attribute-names="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_MERGE_ATTRIBUTE_ATTRIBUTE_NAMES="..."

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.ldap[0].search-entry-handlers.merge-attribute.attribute-names="..."

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.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-name=

The Merge attribute name.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          merge-attribute: 
            merge-attribute-name: 

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.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-name="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_MERGE_ATTRIBUTE_MERGE_ATTRIBUTE_NAME="..."

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.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-name="..."

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.ldap[0].search-entry-handlers.primary-group-id.base-dn=

The Base dn.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.primary-group-id.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          primary-group-id: 
            base-dn: 

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.ldap[0].search-entry-handlers.primary-group-id.base-dn="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_PRIMARY_GROUP_ID_BASE_DN="..."

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.ldap[0].search-entry-handlers.primary-group-id.base-dn="..."

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.ldap[0].search-entry-handlers.primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

The Group filter.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "(&(objectClass=group)(objectSid={0}))"          primary-group-id: 
            group-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.ldap[0].search-entry-handlers.primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))" -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_PRIMARY_GROUP_ID_GROUP_FILTER="(&(objectClass=group)(objectSid={0}))"

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.ldap[0].search-entry-handlers.primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))"

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.ldap[0].search-entry-handlers.recursive.merge-attributes=

The Merge attributes.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.recursive.merge-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          recursive: 
            merge-attributes: 

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.ldap[0].search-entry-handlers.recursive.merge-attributes="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_RECURSIVE_MERGE_ATTRIBUTES="..."

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.ldap[0].search-entry-handlers.recursive.merge-attributes="..."

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.ldap[0].search-entry-handlers.recursive.search-attribute=

The Search attribute.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.recursive.search-attribute=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          recursive: 
            search-attribute: 

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.ldap[0].search-entry-handlers.recursive.search-attribute="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_RECURSIVE_SEARCH_ATTRIBUTE="..."

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.ldap[0].search-entry-handlers.recursive.search-attribute="..."

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.ldap[0].search-entry-handlers.search-referral.limit=10

The default referral limit.

org.apereo.cas.configuration.model.support.ldap.FollowReferralSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.search-referral.limit=10

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "10"          search-referral: 
            limit: 

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.ldap[0].search-entry-handlers.search-referral.limit="10" -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_SEARCH_REFERRAL_LIMIT="10"

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.ldap[0].search-entry-handlers.search-referral.limit="10"

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.ldap[0].search-entry-handlers.search-result.limit=10

The default referral limit.

org.apereo.cas.configuration.model.support.ldap.FollowResultSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.search-result.limit=10

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "10"          search-result: 
            limit: 

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.ldap[0].search-entry-handlers.search-result.limit="10" -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_SEARCH_RESULT_LIMIT="10"

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.ldap[0].search-entry-handlers.search-result.limit="10"

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.ldap[0].search-entry-handlers.type=

The type of search entry handler to choose. Available values are as follows:

FOLLOW_SEARCH_REFERRAL: Provides handling of an ldap referral for search operations.
FOLLOW_SEARCH_RESULT_REFERENCE: Provides handling of an ldap continuation reference for search operations.
ACTIVE_DIRECTORY: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
OBJECT_GUID: Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.
OBJECT_SID: Object sid search entry handler. Handles the objectSid attribute fetching and conversion.
CASE_CHANGE: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
DN_ATTRIBUTE_ENTRY: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.
MERGE: Merge search entry handler. Merges the values of one or more attributes into a single attribute.
PRIMARY_GROUP: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.
RANGE_ENTRY: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.
RECURSIVE_ENTRY: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.
MERGE_ENTRIES: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact.

org.apereo.cas.configuration.model.support.ldap.LdapSearchEntryHandlersProperties.

_{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.ldap[0].search-entry-handlers.type=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    attribute-repository: 
      - ldap: 
        search-entry-handlers: "..."          type: 

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.ldap[0].search-entry-handlers.type="..." -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_LDAP[0]_SEARCH_ENTRY_HANDLERS_TYPE="..."

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.ldap[0].search-entry-handlers.type="..."

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.ldap[0].validator.attribute-name=objectClass

Attribute name to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{How can I configure this property?}