Skip to main content
Version: 1.30.0

Authorization Properties

Use the following properties to set up the authorization and login, including key email messages, default language and timezone, content of the login page, links, and others.

To get a list of available system properties, navigate to System Properties → All Properties.

email.reset_password.email_body​


Specify the email body for the password reset request.

Type: String

Default value: Not defined

Example value: Follow the link to change the password.

email.reset_password.subject​


Specify the subject for the email sent when the password reset was requested.

Type: String

Default value: Not defined

Example value: Your new password.

email.reset_password.unchanged_password​


Specify the message body of the email about an unchanged password.

Type: String

Default value: Not defined

Example value: This user cannot change the password.

email.validation.reg_exp​


Specify a pattern to validate the email addresses. If the property value is empty, the /.*@.*/ expression is used.

warning

Any change to this pattern may cause the email address validation engine to work incorrectly.

Type: String

Default value: /\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,6}\b/

Example value: /.*@.*.ru/

page_access.redirect_url​


Specify a URL redirect from the authorization page for users without the required roles to the Service Portal page.

Type: String

Default value: /portal

simple.auth.attempts_counting_period​


Set the timer (in minutes) that the system will use to track unsuccessful login attempts. When the number of failed attempts within this period exceeds the value specified in the simple.auth.failed_attempts_without_delay system property for the first time, a login delay is activated.

Type: Integer

Default value: 60

Example value: 120

simple.auth.failed_attempts_without_delay​


Set the number of unsuccessful login attempts that will trigger the login delay for the first time. The Login button will also become inactive.

Type: Integer

Default value: 3

Example value: 5

simple.auth.delay_time_increment​


Specify the number of seconds to delay login each time the login delay is triggered by an incorrect login and/or password. The Log in button will also become inactive.

Type: Integer

Default value: 5

Example value: 10

simple.auth_page.help_info.en​


Specify a message that users see when clicking Help on the authorization page. This property is for the message in English.

Type: String

Default value: Not defined

Example value:

<p>If you need help, please contact us</p>
<p>E-mail: service@example.com</p>
<p>Phone: +7(555)30092019</p>
<p><a href='https://simpleone.ru'> Go to support page</a></p>

simple.auth_page.help_info.ru​


Specify a message that users see when clicking Help on the authorization page. This property is for the message in Russian.

Type: String

Default value: Not defined

Example value:

`<p>Если вам требуется консультация, свяжитесь с нами</p>
<p>E-mail: service@example.com</p>
<p>Телефон: +7(555)30092019</p>
<p><a href='https://simpleone.ru'> Go to support page</a></p>

simple.auth_page.support_email​


Specify a contact email for the authorization page.

Type: String

Default value: Not defined

Example value: service@example.com

simple.auth_page.support_phone​


Specify a contact phone for the authorization page. Numbers, spaces and the plus sign (+) are allowed.

Type: String

Default value: Not defined

Example value: +1 800 5555555

simple.auth_page.support_site​


Specify a URL of the service desk site displayed on the authorization page.

Type: String

Default value: Not defined

Example value: https://service.example.com/

simple.auth.strong_password_policy.enabled​


Set the value to true to enable the strong password policy. In this case, all newly created passwords in the system must be at least 8 characters long and include digits (0–9) and uppercase and lowercase letters.

If the value is set to false the password policy is simplified, so that there are only two limitations to the password:

  • the password must contain at least 6 characters.
  • the password cannot consist only of the whitespace characters, such as space, tab, line feed and other.

Type: Boolean

Default value: true

Example value: false

simple.login.username.sensitivity.enabled​


To enable the creation of the similar usernames with case-sensitivity (like "username" and "UserName"), set this property to true.

Type: Boolean

Default value: false

simple.passwordreset.enabled​


To enable the password reset functionality when logging in the system, set the property to true. If this property is set to false, the system rejects password reset requests to API.

Type: Boolean

Default value: false

simple.signup.enabled​


To enable displaying the Sign-up option when logging in the system, set the property to true.

Type: Boolean

Default value: false

simple.user.password_reset_token_expiry​


Specify the password reset token expiration time (in seconds). If not specified, then the default value is applied (3600 seconds, or 1 hour).

Type: Integer

Default value: 3600

simple.username.pattern​


Specify a pattern for username validation.

warning

Make sure that the regular expression is correct. Follow the link to learn about the regular expression syntax.

Type: String

Default value: /^[A-Za-z][A-Za-z0-9_.-@]*$/

simple.sso.active​


To enable the Single Sign-On authorization, set the property to true. The property only enables the SAML authentication.

Type: Boolean

Default value: false

simple.sso.priority_over_welcome_page​


To enable the Single Sign-On login page priority over the welcome page, set the property true.

If the value is true, the redirection leads to the SSO URL only if the simple.sso.active property is set to true.

Type: Boolean

Default value: false

simple.welcome_page.url​


Specify the welcome page URL, or enter false to disable redirection to the page.

Type: String

Default value: Not defined

Example value: portal/login
https://example_welcome_page.com

caution

If the redirection URL is set to a nonexistent page, the redirection leads to one of the existing pages of the portal.

user.language.default​


Set the system language available for users by default on the instance.

Users can change the interface and notification language in the Preferences menu. The "out-of-the-box" solution contains two languages: Russian and English.

Type: String

Default value: en

user.timezone.default​


Specify the user default timezone.

Users can change the default timezone in the Preferences menu.

Type: String

Default value: Not defined

Example value: Europe/Moscow