What properties are available for user-defined notifications?

You can customize the user-defined notifications as required.

Variables may be used to personalize the content of a notification of ARIS Administration. Variables can be used in both notification subject and body.

Users

Key

Description

Valid input

Example

com.aris.umc.notification.userCreated.message

Notify about creation

Specifies whether users are to be notified after they have been created.

true, false

 

com.aris.umc.notification.userCreated.subject

User created - Subject

Subject of the notification that is sent when a user has been created.

String

 

com.aris.umc.notification.userCreated.message

User created - Message

Specifies the text of the notification that is sent when a user has been created.

String

 

com.aris.umc.notification.userCreated.template

User created - HTML template

Specifies the HTML template used for the notification that is sent when users are notified that they have been created. The template must have been uploaded previously.

 

 

com.aris.umc.notification.userDisabled.enabled

Notify about deactivation

Specifies whether users are to be notified after they have been deactivated.

true, false

 

com.aris.umc.notification.userDisabled.subject

User deactivated - Subject

Specifies the subject of the notification that is sent when a user has been deactivated.

String

 

com.aris.umc.notification.userDisabled.message

User deactivated - Message

Specifies the text of the notification that is sent when a user has been deactivated.

String

 

com.aris.umc.notification.userDisabled.template

User deactivated - HTML template

Specifies the HTML template used for the notification that is sent when users are notified that they have been deactivated. The template must have been uploaded previously.

 

 

com.aris.umc.notification.userEnabled.enabled

Notify about activation

Specifies whether users are to be notified after they have been activated.

true, false

 

com.aris.umc.notification.userEnabled.subject

User activated - Subject

Specifies the subject of the notification that is sent when a user has been activated.

String

 

com.aris.umc.notification.userEnabled.message

User activated - Message

Specifies the text of the notification that is sent when a user has been activated.

String

 

com.aris.umc.notification.userEnabled.template

User activated - HTML template

Specifies the HTML template used for the notification that is sent when users are notified that they have been activated. The template must have been uploaded previously.

String

 

Passwords

Key

Description

Valid input

Example

com.aris.umc.notification.passwordChanged.enabled

Notify about password change

Specifies whether users are to be notified after their password has been changed.

true, false

 

com.aris.umc.notification.passwordChanged.subject

Password change - Subject

Specifies the subject of the notification that is sent when a password has been changed.

String

 

com.aris.umc.notification.passwordChanged.message

Password change - Message

Specifies the text of the notification that is sent when a password has been changed.

String

 

com.aris.umc.notification.passwordChanged.template

Password change - HTML template

Specifies the HTML template used for the notification that is sent when a user is to be notified about a password change. The template must have been uploaded previously.

 

 

com.aris.umc.notification.passwordReset.enabled

Notify about password reset

Specifies whether users are to be notified after their password has been reset.

true, false

 

com.aris.umc.notification.passwordReset.subject

Password reset - Subject

Specifies the subject of the notification that is sent when a password has been reset.

String

 

com.aris.umc.notification.passwordReset.message

Password reset - Message

Specifies the text of the notification that is sent when a password has been reset.

String

 

com.aris.umc.notification.passwordReset.template

Password reset - HTML template

Specifies the HTML template used for the notification that is sent when a user is to be notified about a password reset. The template must have been uploaded previously.

 

 

com.aris.umc.notification.passwordResetRequested.enabled

Notify about password reset request

Specifies that users are to be notified if they have requested a password reset.

true, false

 

com.aris.umc.notification.passwordResetRequested.subject

Password reset request - Subject

Specifies the subject of the notification that is sent when a user has requested a password reset.

String

 

com.aris.umc.notification.passwordResetRequested.message

Password reset request - Message

Specifies the text of the notification that is sent when a user has requested a password reset.

String

 

com.aris.umc.notification.passwordResetRequested.template

Password reset request - HTML template

Specifies the HTML template used for the notification that is sent when a user has requested a password reset. The template must have been uploaded previously.

 

 

Licenses

Key

Description

Valid input

Example

com.aris.umc.notification.licenseExpired.enabled

Notify about license expiration

Specifies whether administrators with the License management privilege are to be notified when a license has expired.

true, false

true

com.aris.umc.notification.licenseExpired.subject

License has expired - Subject

Specifies the subject of the notification that is sent when a license has expired.

String

 

com.aris.umc.notification.licenseExpired.message

License has expired - Message

Specifies the text of the notification that is sent when a license has expired.

String

 

com.aris.umc.notification.licenseExpired.template

License has expired - HTML template

Specifies the HTML template used for the notification that is sent when an administrator is to be notified that a license has expired. The template must have been uploaded previously.

 

 

com.aris.umc.notification.licenseExpiring.enabled

Notify before license expiration

Specifies whether administrators with the License management privilege are to be notified when a license is about to expire.

true, false

true

com.aris.umc.notification.licenseExpiring.threshold

Days before expiration

Specifies how many days before license expiration a notification is sent.

Integer > 0

14

com.aris.umc.notification.licenseExpiring.subject

License will expire soon - Subject

Specifies the subject of the notification that is sent when a license is about to expire.

String

 

com.aris.umc.notification.licenseExpiring.message

License will expire soon - Message

Specifies the text of the notification that is sent when a license is about to expire.

String

 

com.aris.umc.notification.licenseExpiring.template

License will expire soon - HTML template

Specifies the HTML template used for the notification that is sent when an administrator is to be notified that a license will soon expire. The template must have been uploaded previously.

 

 

com.aris.umc.notification.licenseSeatsConsumed.enabled

Notify about license exhaustion

Specifies whether administrators with the License management privilege are to be notified when the total number of logins allowed for the license is reached.

true, false

true

com.aris.umc.notification.licenseSeatsConsumed.threshold

Remaining license seats

Defines how many license seats are allowed to be left before a notification is sent to inform users about the upcoming expiration of a license.

In the case of named licenses, a notification is sent as soon as only the specified number of licenses are left from the total number of licenses available.

In the case of concurrent licenses, a notification is sent as soon as only the specified number of logins are left.

Integer > 0

5

com.aris.umc.notification.licenseSeatsConsumed.subject

License exhaustion - Subject

Specifies the subject of the notification that is sent when the total number of logins allowed for the license is reached.

String

 

com.aris.umc.notification.licenseSeatsConsumed.message

License exhaustion - Message

Specifies the text of the notification that is sent when a license has expired.

String

 

com.aris.umc.notification.licenseSeatsConsumed.template

License exhaustion - HTML template

Specifies the HTML template used for the notification that is sent when an administrator is to be notified that a license will soon expire. The template must have been uploaded previously.

 

 

Tenants

Key

Description

Valid input

Example

com.aris.umc.notification.tenantDeleted.enabled

Notify about deletion

Specifies whether a notification is sent if a tenant was deleted.

true, false

true

com.aris.umc.notification.tenantDeleted.sendToAll.enabled

Notify all users about deletion

Specifies whether a notification is to be sent to all users.

true, false

true

com.aris.umc.notification.tenantDeleted.subject

Tenant deleted - Subject

Specifies the subject of the notification that is sent if a tenant was deleted.

String

 

com.aris.umc.notification.tenantDeleted.message

Tenant deleted - Message

Specifies the text of the notification that is sent if a tenant was deleted.

String

 

com.aris.umc.notification.tenantDeleted.template

Tenant deleted - HTML template

Specifies the HTML template used for the notification that is sent when an administrator is to be notified that a tenant has been deleted. The template must have been uploaded previously.

 

 

com.aris.umc.notification.tenantDisabled.enabled

Notify about deactivation

Specifies whether a notification is sent if a tenant was deactivated.

true, false

true

com.aris.umc.notification.tenantDisabled.sendToAll.enabled

Notify all users about deactivation

Specifies whether a notification is sent to all users if a tenant was deactivated.

true, false

true

com.aris.umc.notification.tenantDisabled.subject

Tenant deactivated - Subject

Specifies the subject of the notification that is sent if a tenant was deactivated.

String

 

com.aris.umc.notification.tenantDisabled.enabled

Tenant deactivated - Message

Specifies the text of the notification that is sent if a tenant was deactivated.

String

 

com.aris.umc.notification.tenantDisabled.template

Tenant deactivated - HTML template

Specifies the HTML template used for the notification that is sent when an administrator is to be notified that a tenant has been deactivated. The template must have been uploaded previously.

 

 

com.aris.umc.notification.tenantEnabled.enabled

Notify about activation

Specifies whether a notification is sent if a tenant was activated.

true, false

true

com.aris.umc.notification.tenantEnabled.sendToAll.enabled

Notify all users about activation

Specifies whether a notification is sent to all users if a tenant was activated.

true, false

true

com.aris.umc.notification.tenantEnabled.subject

Tenant activated - Subject

Specifies the subject of the notification that is sent if a tenant was activated.

String

 

com.aris.umc.notification.tenantEnabled.message

Tenant activated - Message

Specifies the text of the notification that is sent if a tenant was activated.

String

 

com.aris.umc.notification.tenantEnabled.template

Tenant activated - HTML template

Specifies the HTML template used for the notification that is sent when an administrator is to be notified that a tenant has been activated. The template must have been uploaded previously.

 

 

Multi-factor authentication

Key

Description

Valid input

Example

com.aris.umc.notification.otpRequested.enabled

Notify about one-time password request

Specifies whether users are to be notified if they have requested a one-time password.

true, false

 

com.aris.umc.notification.otpRequested.subject

One-time password request - Subject

Subject of the notification that is sent when a user has requested a one-time password.

String

 

com.aris.umc.notification.otpRequested.message

One-time password request - Message

Text of the notification that is sent when a user has requested a one-time password.

String

 

com.aris.umc.notification.otpRequested.template

One-time password request - HTML template

Specifies the HTML template used for the notification that is sent when a user has requested a one-time password. The template must have been uploaded previously.

 

 

com.aris.umc.notification.otpSecretChanged.enabled

Notify about token secret change

Specifies whether users are to be notified if their token secret has been changed.

true, false

 

com.aris.umc.notification.otpSecretChanged.subject

Token secret change - Subject

Subject of the notification that is sent when the token secret has been changed by a user.

String

 

com.aris.umc.notification.otpSecretChanged.message

Token secret change - Message

Text of the notification that is sent when the token secret has been changed by a user.

String

 

com.aris.umc.notification.otpSecretChanged.template

Token secret change - HTML template

Specifies the HTML template used for the notification that is sent when a user has changed the token secret. The template must have been uploaded previously.

 

 

OAuth

Key

Description

Valid input

Example

com.aris.umc.notification.signupCompleted.enabled

Notify about signup

Specifies whether administrators are to be notified if a new user has signed up.

true, false

 

com.aris.umc.notification.signupCompleted.subject

Signup complete - Subject

Subject of the notification that is sent when a new user has signed up.

String

 

com.aris.umc.notification.signupCompleted.message

Signup complete - Message

Text of the notification that is sent when a new user has signed up.

String

 

com.aris.umc.notification.signupCompleted.template

Signup complete - HTML template

Specifies the HTML template used for the notification that is sent when a new user has signed up. The template must have been uploaded previously.