REST Attribute Resolution
The following configuration describes how to fetch and retrieve attributes from REST attribute repositories.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.attribute-repository.rest[0].urlThe endpoint URL to contact and retrieve attributes.
The endpoint URL to contact and retrieve attributes.
cas.authn.attribute-repository.restRetrieve attributes from multiple REST endpoints.
Retrieve attributes from multiple REST endpoints.
cas.authn.attribute-repository.rest[0].basic-auth-passwordIf REST endpoint is protected via basic authentication, specify the password for authentication.
If REST endpoint is protected via basic authentication, specify the password for authentication.
cas.authn.attribute-repository.rest[0].basic-auth-usernameIf REST endpoint is protected via basic authentication, specify the username for authentication.
If REST endpoint is protected via basic authentication, specify the username for authentication.
cas.authn.attribute-repository.rest[0].headersHeaders, defined as a Map, to include in the request when making the REST call.
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.
cas.authn.attribute-repository.rest[0].idA value can be assigned to this field to uniquely identify this resolver.
A value can be assigned to this field to uniquely identify this resolver.
cas.authn.attribute-repository.rest[0].maximum-retry-attemptsWhen attempting to reach the endpoint, this setting controls the number of retry attempts that CAS should execute Setting this value to a zero or negative value will disable the retry policy.
3When attempting to reach the endpoint, this setting controls the number of retry attempts that CAS should execute Setting this value to a zero or negative value will disable the retry policy.
cas.authn.attribute-repository.rest[0].methodHTTP method to use when contacting the rest endpoint.
GETHTTP method to use when contacting the rest endpoint. Examples include GET, POST, etc.
cas.authn.attribute-repository.rest[0].orderThe order of this attribute repository in the chain of repositories.
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.
cas.authn.attribute-repository.rest[0].stateWhether attribute resolution based on this source is enabled.
ACTIVE-
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.
cas.authn.attribute-repository.rest[0].username-attributeThe attribute name that would be used to look up and determine the user id from the query map.
usernameThe attribute name that would be used to look up and determine the user id from the query map. The value linked to this attribute would be used as the username or subject by the attribute repository to pass on to the ultimate source to locate the user record.
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.
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.
The authenticating user id is passed in form of a request parameter under username. The response is expected
to be a JSON map as such:
1
2
3
4
5
{
"name" : "JohnSmith",
"age" : 29,
"messages": ["msg 1", "msg 2", "msg 3"]
}
Multitenancy
Configuration settings for REST attribute resolution can be specified in a multitenant environment. Please review this guide for more information.