6.6. WebUI Policies

6.6.1. login_mode

type: string

allowed values: “userstore”, “privacyIDEA”, “disable”

If set to userstore (default), users and administrators need to authenticate with the password of their userstore, being an LDAP service or an SQL database.

If this action is set to login_mode=privacyIDEA, the users and administrators need to authenticate against privacyIDEA when logging into the WebUI. I.e. they can not login with their domain password anymore but need to authenticate with one of their tokens.

If set to login_mode=disable the users and administrators of the specified realms can not login to the UI anymore.

Warning

If you set this action and the user deletes or disables all his tokens, he will not be able to login anymore.

Note

Administrators defined in the database using the pi-manage command can still login with their normal passwords.

Note

A sensible way to use this, is to combine this action in a policy with the client parameter: requiring the users to login to the Web UI remotely from the internet with OTP but still login from within the LAN with the domain password.

Note

Another sensible way to use this policy is to disable the login to the web UI either for certain IP addresses (client) or for users in certain realms.

6.6.2. remote_user

type: string

This policy defines, if the login to the privacyIDEA using the web servers integrated authentication (like basic authentication or digest authentication) should be allowed.

Possible values are “disable” and “allowed”.

Note

The policy is evaluated before the user is logged in. At this point in time there is no realm known, so a policy to allow remote_user must not select any realm.

Note

The policy login_mode and remote_user work independent of each other. I.e. you can disable login_mode and allow remote_user.

You can use this policy to enable Single-Sign-On and integration into Kerberos or Active Directory. Add the following template into you apache configuration in /etc/apache2/sites-available/privacyidea.conf:

<Directory />
        # For Apache 2.4 you need to set this:
        # Require all granted
        Options FollowSymLinks
        AllowOverride None

        SSLRequireSSL
        AuthType Kerberos
        AuthName "Kerberos Login"
        KrbMethodNegotiate On
        KrbMethodK5Passwd On
        KrbAuthRealms YOUR-REALM
        Krb5KeyTab /etc/apache2/http.keytab
        KrbServiceName HTTP
        KrbSaveCredentials On
        <RequireAny>
            # Either we need a URL with no authentication or we need a valid user
            <RequireAny>
                # Any of these URL do NOT need a basic authentication
                Require expr %{REQUEST_URI} =~ m#^/validate#
                Require expr %{REQUEST_URI} =~ m#^/ttype#
            </RequireAny>
            Require valid-user
        </RequireAny>
</Directory>

6.6.3. logout_time

type: int

Set the timeout, after which a user in th WebUI will be logged out. The default timeout is 120 seconds.

Being a policy this time can be set based on clients, realms and users.

6.6.4. token_page_size

type: int

By default 15 tokens are displayed on one page in the token view. On big screens you might want to display more tokens. Thus you can define in this policy how many tokens should be displayed.

6.6.5. user_page_size

type: int

By default 15 users are displayed on one page in the user view. On big screens you might want to display more users. Thus you can define in this policy how many users should be displayed.

6.6.6. policy_template_url

type: str

Here you can define a URL from where the policies should be fetched. The default URL is a Github repository [#defaulturl]_.

Note

When setting a template_url policy the modified URL will only get active after the user has logged out and in again.

1

https://github.com/privacyidea/policy-templates/.

6.6.7. default_tokentype

type: str

You can define which is the default tokentype when enrolling a new token in the Web UI. This is the token, which will be selected, when entering the enrollment dialog.

6.6.8. tokenwizard

type: bool

If this policy is set and the user has no token, then the user will only see an easy token wizard to enroll his first token. If the user has enrolled his first token and he logs in to the web UI, he will see the normal view.

The user will enroll a token defined in default_tokentype.

Other sensible policies to combine are in User Policies the OTP length, the TOTP timestep and the HASH-lib.

You can add a prologue and epilog to the enrollment wizard in the greeting and after the token is enrolled and e.g. the QR code is displayed.

Create the files

  • static/customize/views/includes/token.enroll.pre.top.html

  • static/customize/views/includes/token.enroll.pre.bottom.html

  • static/customize/views/includes/token.enroll.post.top.html

  • static/customize/views/includes/token.enroll.post.bottom.html

to display the contents in the first step (pre) or in the second step (post).

Note

You can change the directory static/customize to a URL that fits your needs the best by defining a variable PI_CUSTOMIZATION in the file pi.cfg. This way you can put all modifications in one place apart from the original code.

If you want to adapt the privacyIDEA look and feel even more, read Customization.

6.6.9. realm_dropdown

type: str

If this policy is activated the web UI will display a realm dropdown box. Of course this policy can not filter for users or realms, since the user is not known at this moment.

The type of this action was changed to “string” in version 2.16. You can set a space separated list of realm names. Only these realmnames are displayed in the dropdown box.

Note

The realm names in the policy are not checked, if they really exist!

6.6.10. search_on_enter

type: bool

The searching in the user list is performed as live search. Each time a key is pressed, the new substring is searched in the user store.

Sometimes this can be too time consuming. You can use this policy to change the bahaviour that the administrator needs to press enter to trigger the search.

(Since privacyIDEA 2.17)

6.6.11. custom_baseline

type: str

The administrator can replace the file templates/baseline.html with another template. This way he can change the links to e.g. internal documentation or ticketing systems. The new file could be called mytemplates/mybase.html.

This will only work with a valid subscription of privacyIDEA Enterprise Edition.

Note

This policy is evaluated before login. So any realm or user setting will have no effect. But you can specify different baselines for different client IP addresses.

If you want to adapt the privacyIDEA look and feel even more, read Customization.

(Since privacyIDEA 2.21)

6.6.12. custom_menu

type: str

The administrator can replace the file templates/menu.html with another template. This way he can change the links to e.g. internal documentation or ticketing systems. The new file could be called mytemplates/mymenu.html.

This will only work with a valid subscription of privacyIDEA Enterprise Edition.

Note

This policy is evaluated before login. So any realm or user setting will have no effect. But you can specify different menus for different client IP addresses.

If you want to adapt the privacyIDEA look and feel even more, read Customization.

(Since privacyIDEA 2.21)

6.6.13. hide_buttons

type: bool

Buttons for actions that a user is not allowed to perform, are hidden instead of being disabled.

(Since privacyIDEA 3.0)

6.6.14. login_text

type: str

This way the text “Please sign in” on the login dialog can be changed. Since the policy can also depend on the IP address of the client, you can also choose different login texts depending on from where a user tries to log in.

(Since privacyIDEA 3.0)

6.6.15. show_android_privacyidea_authenticator

type: bool

If this policy is activated, the enrollment page for HOTP, TOTP and Push tokens will contain a QR code, that leads the user to the Google Play Store where he can directly install the privacyIDEA Authenticator App for Android devices.

(Since privacyIDEA 3.3)

6.6.16. show_ios_privacyidea_authenticator

If this policy is activated, the enrollment page for HOTP, TOTP and Push tokens will contain a QR code, that leads the user to the Apple App Store where he can directly install the privacyIDEA Authenticator App for iOS devices.

type: bool

(Since privacyIDEA 3.3)

6.6.17. show_custom_authenticator

type: str

If this policy is activated, the enrollment page for HOTP, TOTP and Push tokens will contain a QR code, that leads the user to the given URL.

The idea is, that an organization running privacyIDEA can create its own URL, where the user is taken to, e.g.

  • Show information about the used Authenticator apps…

  • Do a device identification and automatically redirect the user to Google Play Store or Apple App Store. Thus only need the user to show one QR code…

  • If an organization has it’s own customized app or chooses to use another app, lead the user to another App in the Google Play Store or Apple App Store.

Other scenarios are possible.

(Since privacyIDEA 3.3)

6.6.18. indexedsecret_preset_attribute

type: str

The secret in the enrollment dialog of the tokentype indexedsecret is preset with the value of the given user attribute.

For more details of this token type see Indexed Secret Token.

(Since privacyIDEA 3.3)

6.6.19. admin_dashboard

type: bool

If this policy is activated, the static dashboard can be accessed by administrators. It is displayed as a starting page in the WebUI and contains information about token numbers, authentication requests, recent administrative changes, policies, event handlers and subscriptions.

(Since privacyIDEA 3.4)