APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Password Management - REST

Tasks such as locating users’ email and security questions as well as management and updating of the password are delegated to user-defined rest endpoints.

REST support is enabled by including the following dependencies in the WAR overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



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





1



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





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-pm-rest"
}

The following settings and properties are available from the CAS configuration catalog:

cas.authn.pm.rest.endpoint-passwordPassword for Basic-Auth at the password management endpoints.
no default
Required

Password for Basic-Auth at the password management endpoints.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-url-account-unlockEndpoint URL to use when unlocking account.
no default
Required

Endpoint URL to use when unlocking account.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-url-changeEndpoint URL to use when updating passwords..
no default
Required

Endpoint URL to use when updating passwords..

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-url-emailEndpoint URL to use when locating email addresses.
no default
Required

Endpoint URL to use when locating email addresses.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-url-phoneEndpoint URL to use when locating phone numbers.
no default
Required

Endpoint URL to use when locating phone numbers.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-url-security-questionsEndpoint URL to use when locating security questions.
no default
Required

Endpoint URL to use when locating security questions.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-url-userEndpoint URL to use when locating user names.
no default
Required

Endpoint URL to use when locating user names.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.endpoint-usernameUsername for Basic-Auth at the password management endpoints.
no default
Required

Username for Basic-Auth at the password management endpoints.

Type
String
Default
none
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.field-name-passwordField name for password field when password change requests are submitted.
password
Required

Field name for password field when password change requests are submitted.

Type
String
Default
password
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.field-name-password-oldField name for oldPassword field when password change requests are submitted.
oldPassword
Required

Field name for oldPassword field when password change requests are submitted.

Type
String
Default
oldPassword
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.field-name-userField name for username field when password change requests are submitted.
username
Required

Field name for username field when password change requests are submitted.

Type
String
Default
username
Defined by
RestfulPasswordManagementProperties
cas.authn.pm.rest.headersAdditional headers to be included in REST API calls for password management.
no default

Additional headers to be included in REST API calls for password management. The map keys are header names and the corresponding values are header values.

Type
Map<String,String>
Default
none
Defined by
RestfulPasswordManagementProperties

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.

:information_source: 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.

Endpoint Method Query Parameter(s) Request Body Expected Response
Get Email Address GET username None 200. Email address in the body.
Get Phone Number GET username None 200. Phone number in the body.
Get Security Questions GET username None 200. Security questions map in the body.
Update Security Questions POST username Security questions map in the body. 200. true/false in the body.
Update Password POST None username, password, oldPassword 200. true/false in the body.
Unlock Account POST username None 200. true/false in the body.

By default, all requests are submitted using the Accept header application/json, Content-Type header set to application/json and Accept-Charset header set to UTF-8.