CentraSite 10.11 | CentraSite User’s Guide | Runtime Governance | Access Token Management | Managing Access Tokens through CentraSite Business UI | Configuring Email Templates | Configuring Email Templates for Access Token Expiration
 
Configuring Email Templates for Access Token Expiration
Notifications informing about the upcoming API key and OAuth 2.0 token expirations, and the newly generated access tokens are sent to the API Consumer.
CentraSite supports the following types of notifications for the access token expiration:
*Access token has expired - a critical event type message.
*Access token expires soon - a warning type message. It is generated n days before the token expiration date and displayed every day before the token actually expires.
*To configure email templates for access token expiration
1. Open the customization file, centrasite.xml, in a rich text editor.
You can find the centrasite.xml file on <CentraSiteInstall_Directory>\cast\cswebapps\BusinessUI\custom\conf.
2. Locate the property ExpiryNotificationSettings.
The notification settings for the API key and OAuth 2.0 token expiration would look like the following:
<ExpiryNotificationSettings>
<ExpiredNotification
subject="Access key has expired!"
template="APIKeyExpiredNotification.html" />
<AdvanceNotification
subject="Access key about to expire!"
template="APIKeyExpirationNotification.html" />
<SchedulerExecutionFrequency>12h</SchedulerExecutionFrequency>
<AdvanceNotificationInterval>5d</AdvanceNotificationInterval>
</ExpiryNotificationSettings>
3. Uncomment the section API KEY EXPIRATION CONFIGURATION to enable the access token expiration notifications.
4. Use the property, ExpiredNotification, to set the subject and body of the notification message for the API Consumers whose access token has expired.
5. Use the property, AdvanceNotification, to set the subject and body of the notification message for the API Consumers whose access tokens are due to expire.
6. Use the property, SchedulerExecutionFrequency, to specify how frequently to check for the expiration status of access tokens. Enter the time interval in the following format: years (y), months (m), days (d), hours (h), minutes (min).
7. Use the property, AdvanceNotificationInterval, to specify how many days should the consumers be notified before the access token expiration (in days). The consumers receive a notification message as configured in the AdvanceNotification property. Enter the time interval in the following format: years (y) months (m) days (d) hours (h) minutes (min).
8. Save and close the file.
Important:
If you have set up a Software AG Runtime cluster with load balancing, locate the CENTRASITE ACCESS URL CONFIGURATION element, and ensure that the lb_or_reverse_proxy_url attribute in the following property points to the load balancer's IP/Port.
<CentraSite url="http://localhost:53307/CentraSite/CentraSite"
lb_or_reverse_proxy_url="http://localhost:53307"/>
9. Restart Software AG Runtime.