Invitation | Message Setup
When configuring the Cirrus Invitation Service for a service provider, there are a number of configurable user interface dialog messages and email messages. Many of these can be further customized using substitution strings. The following table outlines the messages, the purpose for each, and the order of the message.
|Org level email
|The default subject line for email messages send by Cirrus Invitation. When sending invitations or account linking requests via Cirrus APIs, the subject line can be changed.||X||X|
|Org level message to append to all outgoing invite/acct link request emails||A block of content that is appended to the bottom of all invite or account linking request emails. Generally accepted practice is to establish the “INVITATION_LINK” substitution variable and any minimal narrative here so that it is presented uniformly.||X||X|
|Sponsor Web Form (“Instructions for Sponsor”)||The instructions for sponsors when the the Cirrus Invitation web form is used.||X|
|Invite/Acct Link Request Email||The content of the email send to the end user’s email address. The message should include the request URL defined by the “INVITATION_LINK” substitution variable. This message will have content defined at the org level appended at the end.
NOTE: There is a configuration option to allow the suppression of this message. This option should only be used after consulting with Cirrus Identity Support.
|Invite / Acct Link Request Claim UI (“Instructions for Guest”)||The instructions that will be displayed to the end user after clicking the URL contained in the Invitation or Account Linking request email. The end user will be asked to respond to a terms-of service and then be presented with login options to claim the request. Those login options will be a function of the Invitation configuration and the options set by Cirrus Discovery.||2||X||X|
|Self-Reg UI (“Instructions for Guest”)||The instructions that will be displayed to the end user after clicking the self-registration URL. The end user will be asked to respond to a terms-of service and then be presented with login options to self-register. Those login options will be a function of the Self-Register configuration and the options set by Cirrus Discovery.||X|
|Terms of Service||Invitation, API based Account Linking, and Self-Registration all have a requirement for the end user to agree to terms-of-service (ToS) before selecting a method of login. There is also an option to allow a terms-of-service check for Sponsors when using the Invitation web form or file upload. The ToS can either be presented inline or be a URL.||2||X||X||X|
|Email Address Verification UI||During the claim process, if the email address entered is not asserted from an identity provider, or in the case of Invitation / API based Account Linking is not the address the request was sent to, the end user will be asked to verify the email address. The content of this message is currently not configurable.||3||X||X||X|
|Guest Feedback UI||After the end user successfully completes the claim process, they are now considered a guest and will be presented online feedback including both the data collected and messaging configured by the customer.||4a||X||X||X|
|Guest Feedback Email||The guest will also receive an email to the email address that was established by the claim process. This address can be different from the original email address where the guest received the invitation/account linking request URL.||4b||X||X||X|
|Sponsor Feedback Email||When Cirrus Invitation is used, the sponsor will receive an email once the invitation claim process is complete.||5||X|
|Service Provider Invite/Acct Link Authorization Error UI||When Invitation or Account Linking is used to control access to a service provider, this message will be presented when access is not allowed.||6||X||X|
|Self-Reg New Registration Warning||If the “Show warning page” option is enabled, end users that have not previously registered will receive a warning that they have not registered for the service provider. The end user will then be given prompts to either go back and try a different login provider or to proceed on to self-register. The content of this message is currently not configurable.||X|
|Guest Expire Notification Email||If configured, the guest will receive a message 30 days before their invitation expires.||7||X||X||X|
|Sponsor Expire Notification Email||If configured, the sponsor will receive a message containing a list (max of 20) guests that will be expiring in 30 days. If there are more than 20 guests assigned to the sponsor expiring on the same day, the list indicates the first 20 and there are additional.||8||X|
A substitution string is a code word that is replaced by values from your Org and SP configuration when the message is displayed or the email is sent. The following table describes the available substitution strings and which messages they can be used for.
|Substitution String||Description||Step 1||Step 2||Step 3||Step 4a||Step 4b||Step 5||Step 6||Step 7||Step 8|
|APPLICATION_NAME||The "Friendly Name" of the application, from the SP configuration.||X||X||X||X||X||X||X||X||X|
|APPLICATION_LINK||The URL of the application, from the SP invitation configuration.||X||X||X||X||X||X||X||X|
|EMAIL_VALIDATION_CODE||The validation code used to validate a new email address. This is dynamically generated when a request is sent.||X|
|GUEST_SUPPORT_EMAIL||Email address to which support requests should be directed. This is taken from the SP invitation configuration.||X||X||X||X||X||X||X||X|
|GUEST_FIRST_NAME||The first name of the guest.||X||X||X||X|
|GUEST_LAST_NAME||The last name of the guest.||X||X||X||X|
|GUEST_EMAIL||The email address of the guest used for the invite.
NOTE: This value will change if the the end user claims the invitation with an email address different from the orientating address (see INVITE_EMAIL). Once the claim process is complete, this value will reflect the "mail" value on the guest object.X
|GUEST_EPPN||The guest's ePPN.
NOTE: This is only known after the guest has accepted the invitation.
|GUEST_EXPIRATION_DATE||The date on which the guest account will expire. The date will be in the 'Mon DD, YYYY' format, for example 'Jan 1, 2020'.||X||X||X|
|GUEST_SOCIAL_PROVIDER||The social login provider that was used to claim the invitation.
NOTE: This is only known after the guest has accepted the invitation.
|GUESTS_TO_EXPIRE||The consolidated list of guests assoicated with the sponsor that will expire.||X|
|INVITE_EMAIL||The email address the invitation was initially sent to. This value does not change and will be reflected by the data value "mailForInvite" on the guest object.
NOTE: This is only reported after the guest has accepted the invitation. Before that, it would equal the GUEST_EMAIL.
|INVITATION_LINK||The URL to include in the invitation. The user will click on this link to accept the invitation.||X|
|INVITATION_VALIDITY_PERIOD||Number of days the invitation will remain valid.||X|
|SPONSOR_EMAIL||The email address of the sponsor.||X||X||X||X||X||X||X|
|SPONSOR_FIRST_NAME||The first name of the sponsor.||X||X||X||X||X||X||X|
|SPONSOR_LAST_NAME||The last name of the sponsor||X||X||X||X||X||X||X|
|SPONSOR_FULL_NAME||Full name of sponsor, equivalent to 'SPONSOR_FULL_NAME SPONSOR_LAST_NAME'||X||X||X||X||X||X||X|