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.

  • cas.authn.attribute-repository.syncope.basic-auth-username=
  • Specify the username for REST authentication.

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

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

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

  • cas.authn.attribute-repository.syncope.url=
  • Syncope instance URL primary used for REST.

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

    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.

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

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

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

  • cas.authn.attribute-repository.syncope.state=
  • Whether attribute resolution based on this source is enabled. Available values are as follows:

    • ACTIVE: Active and enabled repository, and is invoked by default automatically.
    • DISABLED: Attribute repository is disabled and will not be used to resolve people and attributes.
    • STANDBY: Repository is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for and will not be registered into the resolution plan.

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