Microsoft Azure Active Directory Attribute Resolution
The following configuration describes how to fetch and retrieve attributes from Microsoft Azure Active Directory attribute repositories.
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-azuread-authentication</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-azuread-authentication:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-azuread-authentication"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references are included automatically and are listed for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-azuread-authentication"
}
The following settings and properties are available from the CAS configuration catalog:
cas.authn.attribute-repository.azure-active-directory[0].client-idClient id of the registered app in microsoft azure portal.
Client id of the registered app in microsoft azure portal.
cas.authn.attribute-repository.azure-active-directory[0].client-secretClient secret of the registered app in microsoft azure portal.
Client secret of the registered app in microsoft azure portal.
cas.authn.attribute-repository.azure-active-directoryRetrieve attributes from multiple Microsoft Graph instances.
Retrieve attributes from multiple Microsoft Graph instances.
cas.authn.attribute-repository.azure-active-directory[0].api-base-urlBase API url used to contact microsoft graph for calls.
Base API url used to contact microsoft graph for calls.
cas.authn.attribute-repository.azure-active-directory[0].attributesComma-separated attributes and user properties to fetch from microsoft graph.
Comma-separated attributes and user properties to fetch from microsoft graph. If attributes are specified here, they would be the only ones requested and fetched. If this field is left blank, a default set of attributes are fetched and returned.
cas.authn.attribute-repository.azure-active-directory[0].case-insensitiveWhether attribute repository should consider the underlying attribute names in a case-insensitive manner.
Whether attribute repository should consider the underlying attribute names in a case-insensitive manner.
cas.authn.attribute-repository.azure-active-directory[0].domainDomain that is appended to usernames when doing lookups.
Domain that is appended to usernames when doing lookups. The @ is automatically included.
cas.authn.attribute-repository.azure-active-directory[0].grant-typeGrant type used to fetch access tokens; defaults to client_credentials .
Grant type used to fetch access tokens; defaults to client_credentials.
cas.authn.attribute-repository.azure-active-directory[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.azure-active-directory[0].logging-levelAdjust the logging level of the API calls.
Adjust the logging level of the API calls. Defaults to basic. Accepted values are none,headers,basic,body.
cas.authn.attribute-repository.azure-active-directory[0].login-base-urlBase login url used to fetch access tokens.
Base login url used to fetch access tokens.
cas.authn.attribute-repository.azure-active-directory[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.azure-active-directory[0].resourceResource to fetch access tokens for; defaults to the graph api url.
Resource to fetch access tokens for; defaults to the graph api url.
cas.authn.attribute-repository.azure-active-directory[0].scopeScope used when fetching access tokens.
Scope used when fetching access tokens.
cas.authn.attribute-repository.azure-active-directory[0].tenantThe microsoft tenant id.
The microsoft tenant id.
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.