SMS Messaging

CAS presents the ability to notify users on select actions via SMS messaging. Example actions include notification of risky authentication attempts or password reset links/tokens. SMS providers supported by CAS are listed below. Note that an active/professional subscription may be required for certain providers.

Default support for SMS notifications is automatically enabled/included by the relevant modules using the following module:

1
2
3
4
5

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-core-notifications</artifactId>
    <version>${cas.version}</version>
</dependency>

1

implementation "org.apereo.cas:cas-server-core-notifications:${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-core-notifications"
}

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-core-notifications"
}

You need not explicitly include this module in WAR Overlay configurations, except when there is a need to access components and APIs at compile-time. See below on how to customize or override the default behavior with specific providers.

Provider Reference
Custom See this guide.
Groovy See this guide.
REST See this guide.
Twilio See this guide.
TextMagic See this guide.
Clickatell See this guide.
SmsMode See this guide.
Amazon SNS See this guide.
Nexmo See this guide.