Skip to content

Latest commit

 

History

History
37 lines (33 loc) · 1.94 KB

OPERATOR.md

File metadata and controls

37 lines (33 loc) · 1.94 KB
Raw

Operator Support

In order to support multiple tenants and operators, you must prepare the security service to serve customized e-mails and messages.

Structure for templates

Any file in the root of the directory will be used as defaults. The following files must be present:

  • email_invitation.html/txt : This email message will be sent to a newly added user.
  • email_verification.html/txt : This email is sent when an email verification is required.
  • password_reset.html/txt : This is sent when a pasword reset is requested.
  • verification_code.html/txt : This is used during MFA when email based.
  • signup_verification.html/txt : This email is send to a new subscriber who signed up for service.
  • sub_email_verification.html/txt : This is sent to a subscriber requiring an email verification.
  • sub_verification_code.html/txt : This is used during MFA when email based for a subscriber.
  • logo.jpg : The default logo to use in any of these emails.

Structure for wwwassets

Any file in the root of the directory will be used as defaults. The following files must be present:

  • email_verification_error.html : Used when email verification has failed.
  • email_verification_success.html : Used when emil verification has succeeded.
  • invitation_error.html :
  • invitation_success.html :
  • password_policy.html :
  • password_reset.html :
  • password_reset_success.html :
  • password_reset_error.html :
  • signup_verification.html :
  • signup_verification_error.html :
  • signup_verification_success.html :
  • favicon.ico : icon for the application
  • 404_error.html : your customized 404 page
  • the_logo : the logo to use.

For tenants

When creating a tenant/operator, you must create a subdirectory inside each wwwassets and templates and replicate all the files that appear at the root level. You need to use the short Operator name (also known as RegistrantId in the API). This means no spaces, all lowercase characters and numbers. No special characters: 0-9 and a-z.