Two-Factor Authentication (Administrator) - Customizing the PIN and Secret Key Emails Sent to Users

The Two Factor Authentication emails sent to users can be customized:

Procedure

All of the following additional settings must be added to customize the two-factor authentication emails:

  • CustomTFAEmailSubject
  • CustomTFAEmailWithSecret
  • CustomTFAEmailWithoutSecret

Customize the Subject Line

  1. From the CommCell Browser, navigate to the CommServe node.
  2. Right-click the CommServe node and then click Properties.
  3. In the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
  4. In the Add Additional Settings dialog box in the Name field, type CustomTFAEmailSubject.
  5. In the Category box, select CommServDB.GxGlobalParam.
  6. In the Type box, select STRING.
  7. In the Value box, enter the text that will appear in the email subject line, for example, "An extra level of security was added to the CommCell login."
  8. Click OK.

Customize the Email Containing the Secret Key and the PIN

  1. From the CommCell Browser, navigate to the CommServe node.
  2. Right-click the CommServe node and then click Properties.
  3. In the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
  4. In the Add Additional Settings dialog box in the Name field, type CustomTFAEmailWithSecret.
  5. In the Category box, select CommServDB.GxGlobalParam.
  6. In the Type box, select STRING.
  7. In the Value box, enter the text that will appear in the email body as follows:
    • These place holders are required:
      • $$_URL_$$ - In the email body, this is replaced with the URL to the PIN generator documentation.
      • $$_SECRET_$$ - In the email body, this is replaced with the secret key.
      • $$_LOGIN_$$ - In the email body, this is replaced with the user name.
      • $$_PIN_$$ - In the email body, this is replaced with the one time PIN.
    • This place holder is optional:
      • $$_NEWLINE_$$ - In the email body, this is replaced with a blank line.
  8. Click OK.

Example

Entered in the Value box:

Documentation URL:$$_NEWLINE_$$$$_URL_$$ $$_NEWLINE_$$$$_NEWLINE_$$Login:$$_NEWLINE_$$$$_LOGIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Secret:$$_NEWLINE_$$$$_SECRET_$$$$_NEWLINE_$$$$_NEWLINE_$$One Time Pin:$$_NEWLINE_$$$$_PIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Thank you.

What appears in the email body:

Documentation URL:
http://documentation.commvault.com/commvault/release_x_x_x/books_online_1/english_us/features/mobile_app_token/android.htm

Login:
nonadmin

Secret:
FYG526UZLBHXIJPE

One Time Pin:
969410

Thank you.

Customize the Email Containing the PIN

  1. From the CommCell Browser, navigate to the CommServe node.
  2. Right-click the CommServe node and then click Properties.
  3. In the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
  4. In the Add Additional Settings dialog box in the Name field, type CustomTFAEmailWithoutSecret.
  5. In the Category box, select CommServDB.GxGlobalParam.
  6. In the Type box, select STRING.
  7. In the Value box, enter the text that will appear in the email body as follows:
    • These place holders are required:
      • $$_LOGIN_$$ - In the email body, this is replaced with the user name.
      • $$_PIN_$$ - In the email body, this is replaced with the one time PIN.
    • These place holders are optional:
      • $$_URL_$$ - In the email body, this is replaced with the URL to the PIN generator documentation.
      • $$_SECRET_$$ - In the email body, this is replaced with the secret key.
      • $$_NEWLINE_$$ - In the email body, this is replaced with a blank line.
  8. Click OK.

Example

Entered in the Value box:

Login:$$_NEWLINE_$$$$_LOGIN_$$$$_NEWLINE_$$$$_NEWLINE_$$One Time Pin:$$_NEWLINE_$$$$_PIN_$$$$_NEWLINE_$$$$_NEWLINE_$$Thank you.

What appears in the email body:

Login:
nonadmin

One Time Pin:
969410

Thank you.