Configuration Discovery

Certain aspects of the CAS server deployment may be advertised via a discovery endpoint to indicate to client applications and consumers the set of features and capabilities that are turned on. The discovery profile endpoint is enabled by including the following module in the overlay:



1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-discovery-profile</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-discovery-profile:${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-discovery-profile"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
    The following platform references should be included automatically and are listed here 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-discovery-profile"
}

The metadata reported in the discovery profile generally includes two categories of items:

  • Capabilities that could be supported by the CAS server where the feature is available and yet isn’t quite configured and turned on.
  • Capabilities that are actively and currently supported by and configured in the running CAS server.

Examples of reported items include:

  • Service definitions types (CAS, SAML, OAuth, etc)
  • Multifactor Authentication Provider types (WebAuthn, Duo Security, etc)
  • Supported ticket types
  • Available attributes for release
  • …
:information_source: Docs Grow Old

To examine the latest collection of reported metadata, turn on the endpoint and observe the behavior in action. The metadata will continue to grow and improve per every CAS release to accommodate fancier discovery attempts.

Note that this capability and endpoint is turned off by default and its access is controlled similar to all other CAS administrative endpoints. Once the endpoint is turned on, you will need to ensure proper access is granted only to authorized parties via appropriate security options provided by CAS.

Actuator Endpoints

The following endpoints are provided by CAS:

 Produce CAS discovery profile.