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.

Custom

Send text messages using your own custom implementation.

1
2
3
4
@Bean
public SmsSender smsSender() {
    ...
}    

Groovy

Send text messages using an external Groovy script.

1
2
3
4
5
6
7
8
9
10
11
import java.util.*

def run(Object[] args) {
    def from = args[0]
    def to = args[1]
    def message = args[2]
    def logger = args[3]

    logger.debug("Sending message ${message} to ${to} from ${from}")
    true
}

To see the relevant list of CAS properties, please review this guide.

REST

Send text messages using a RESTful API. This is a POST with the following parameters:

Field Description
clientIpAddress The client IP address.
serverIpAddress The server IP address.
from The from address of the text message.
to The target recipient of the text message.

The request body contains the actual message. A status code of 200 is expected from the endpoint.

To see the relevant list of CAS properties, please review this guide.

Twilio

To learn more, visit this site.

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-sms-twilio</artifactId>
    <version>${cas.version}</version>
</dependency>

To see the relevant list of CAS properties, please review this guide.

TextMagic

To learn more, visit this site.

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-sms-textmagic</artifactId>
    <version>${cas.version}</version>
</dependency>

To see the relevant list of CAS properties, please review this guide.

Clickatell

To learn more, visit this site.

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-sms-clickatell</artifactId>
    <version>${cas.version}</version>
</dependency>

To see the relevant list of CAS properties, please review this guide.

Amazon SNS

To learn more, visit this site.

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-sms-aws-sns</artifactId>
    <version>${cas.version}</version>
</dependency>

To see the relevant list of CAS properties, please review this guide.

Nexmo

To learn more, visit this site.

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-sms-nexmo</artifactId>
    <version>${cas.version}</version>
</dependency>

To see the relevant list of CAS properties, please review this guide.