Stub Attribute Resolution

The following configuration describes how to fetch and retrieve attributes from Stub 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.

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.stub.attributes=
  • Static attributes that need to be mapped to a hardcoded value belong here. The structure follows a key-value pair where key is the attribute name and value is the attribute value. The key is the attribute fetched from the source and the value is the attribute name CAS should use for virtual renames.

    Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute.

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

  • cas.authn.attribute-repository.stub.id=
  • A value can be assigned to this field to uniquely identify this resolver.

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

  • cas.authn.attribute-repository.stub.order=
  • 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.core.authentication.StubPrincipalAttributesProperties.

  • cas.authn.attribute-repository.stub.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.core.authentication.StubPrincipalAttributesProperties.