Email Templates

IGA provides custom email templates for specific governance events, such as, welcome, registration, certification assigned, certification reminder, and other events. You also have the ability to create new templates as needed.

Each template uses simple Markdown, a lightweight markup language, for creating formatted XHTML or HTML text. The editor lets you edit or create your email template in Markdown, while seeing the resulting output in another frame. You can activate or deactivate existing template drafts as required.

You also have the option to localize each email template by specifying any ISO 639-1 language code.

Email Variables

Depending on the email type, you can use pre-defined variables depending on the type of identity that uses this template:

Roles Identity Type
Variable Name	Variable
Name	{{object.name}}
Description	{{object.description}}
Condition	{{object.condition}}

Users Identity Type
Variable Name	Variable
Username	{{object.userName}}
Password	{{object.password}}
First Name	{{object.givenName}}
Last Name	{{object.sn}}
Email Address	{{object.mail}}
Description	{{object.description}}
Status	{{object.status}}
Telephone NUmber	{{object.telephoneNumber}}
Address 1	{{object.postalAddress}}
City	{{object.city}}
Postal Code	{{object.city}}
Country	{{object.country}}
State/Province	{{object.stateProvince}}

Assignments Identity Type
Variable Name	Variable
Name	{{object.name}}
Description	{{object.description}}
Mapping	{{object.mapping}}

Accounts Identity Type
Variable Name	Variable
Account Type	{{object.accountType}}

Organization Identity Type
Variable Name	Variable
Name	{{object.name}}
Description	{{object.description}}

Applications Identity Type
Variable Name	Variable
Name	{{object.ownerId}}
Name	{{object.name}}
Description	{{object.description}}

Resources Identity Type
Variable Name	Variable
Name	{{object.name}}
Resource Type	{{object.resourceType}}

Add a New Template

Log in to the IGA UI.
Under Email, click Templates.
Click New Template.
On the New Template modal, enter the template name. This field cannot be blank.
Enter the Template ID. This field cannot be blank and must be unique.
Enter the email address for the group or individual sending the email. This field cannot be blank.
Select the Locale.
1. To add a locale, click the locale drop-down list, and then click Add a locale.
2. Enter a ISO 639-1 language code. For example, FR.
3. Edit the rest of the email in your chosen language.
4. Click Set as Default Locale to make the new language the default setting for this template.
Enter a email subject line.
Enter the body of the email text using Markdown and use any object variables. To view the list of object variables, click the available variables. You can see the results of your text in the right frame.
To reset the inline CSS style of the email template, click Reset styles, and edit any property. You can see the results in the box on the page.
Click Save at the bottom of the page.
The template default to an active state. If you want to keep the template as a draft, click Active and then click Deactivate.

Edit an Existing Template

On the Email Templates page, click any template, and then, click Edit. You can also click the trailing dots on the right, and then click Edit.
Edit the Template Name. This field cannot be left blank.
Edit the Sender email address.
Select the Locale.
1. To add a locale, click the locale drop-down list, and then click Add a locale.
2. Enter a ISO 639-1 language code. For example, FR.
3. Edit the rest of the email in your chosen language.
4. Click Set as Default Locale to make the new language the default setting for this template.
Edit the Subject of the email.
Edit the text in the left frame using Markdown. The resulting output appears in the right frame. You can use any object variables in the body of your text. Click the available variables link to view the current list.
To reset the inline CSS style of the email template, click Reset styles, and edit any property. You can see the results in the box on the page.
Click Save at the bottom of the page.
Click Active to activate the email for use.

Deactivate an Existing Template

You can deactivate any email template in your list to retain drafts.

On the Email Templates page, click any template.
Click Deactivate. The email template is not active and remains on the templates list.

Delete an Existing Template

You can delete any email template in your list.

You cannot recover the email once it has been deleted. If you still want to retain the template, deactivate it for later use.

On the Email Templates page, click any template.
Review the template.
Click Delete Template.

IGA 2021.11.0