Creating guest accounts through REST API do not trigger email or sms by default.

Aruba Employee
Requirement:

How to send guest details in email/sms when creating guest accounts through REST API?



Solution:

The below fields need to be passed in the REST API POST to deliver guest details in email/sms when creating guest accounts.

"auto_send_smtp": 1

"auto_send_sms": 1



Configuration:

This article is focused only on what is needed to send guest receipt in email/sms. Please refer the below link for more details on how to create/update/delete guest accounts through REST API.

https://community.arubanetworks.com/t5/AAA-NAC-Guest-Access-BYOD/How-to-create-update-delete-ClearPass-Guest-Accounts-using-REST/ta-p/243745

 

Requirements:

SMTP server should be configured under Policy Manager >> Administration >> External Servers >> Messaging Setup and working.

SMS gateway should be configured under Guest Manager >> Configuration >> SMS Services >> Gateways and working.

 

Pass the below highlighted fields in the REST API POST when creating guest accounts to send guest receipts in email/sms

{
  "do_expire": 4,
  "expire_time": "1507632999",
  "username": abc@arubanetworks.com",
  "password": "aruba123",
  "email": "abc@arubanetworks.com",           // required for SMTP  
  "visitor_phone": 1xxxxxxxxxx,                     // required for SMS
  "role_id": 2,
  "auto_send_smtp": 1,                                        // required for SMTP
  "auto_send_sms": 1,                                          // required for SMS
  "enabled": true
}

 

Note: If you are using SMS over SMTP as SMS gateway, then "visitor_carrier" field must also be passed in the POST.

Example:

{
  "do_expire": 4,
  "expire_time": "1507632999",
  "username": "abc@arubanetworks.com",
  "password": "aruba123",
  "email": "abc@arubanetworks.com",
  "visitor_phone": 1xxxxxxxxxx,
  "visitor_carrier": "AT&T Wireless",
  "role_id": 2,
  "auto_send_smtp": 1,
  "auto_send_sms": 1,
  "enabled": true
}

 



Verification

Creating guest account"

 

Email Delivered:

 

SMS Delivered:

 

Version history
Revision #:
2 of 2
Last update:
Tuesday
Updated by:
 
Labels (1)
Contributors
Search Airheads
cancel
Showing results for 
Search instead for 
Did you mean: