This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Authentication

1 - Login

This HOWTO shows how to log into the Stroom User Interface.

This walks through a first login as the default admin account. For what happens behind these screens, and for account states, lockouts and password resets, see Signing In.

Assumptions

  • The deployment uses Stroom’s internal Identity Provider (IDP) Identity Provider (IDP) An Identity Provider is a system or service that can authenticate a user and assert their identity. Identity providers can support single sign on (SSO), which allows the user to sign in once to the Identity Provider so they are then authenticated to all systems using that IDP.Click to see more details....
  • The default admin account exists with the password admin. This account is only created when stroom.security.identity.autoCreateAdminAccountOnBoot is enabled, which is not the default. See Internal IDP.
  • For certificate login, the deployment has stroom.security.identity.allowCertificateAuthentication enabled.

Manual Login

Enter admin into the User Name: entry box and admin into the Password: entry box.

images/HOWTOs/UI-Login-01.png

Stroom UI Login - logging in as admin

Press the Login button. As this is the account’s first login, you are told the password must be changed before you can continue.

images/HOWTOs/UI-Login-02.png

Stroom UI Login - password expiry

Press OK , then enter the old password admin and a new password with confirmation. The new password must meet the configured password policy.

images/HOWTOs/UI-Login-03.png

Stroom UI Login - password change

Press OK again to see the confirmation that the password has changed.

images/HOWTOs/UI-Login-04.png

Stroom UI Login - password change confirmation

On pressing Close you are logged in as the admin user, and are presented with the Main Menu, and the Explorer and Welcome panels.

images/HOWTOs/UI-Login-06.png

Stroom UI Login - user logged in

You will not be asked to change this password again until it reaches the age set by stroom.security.identity.passwordPolicy.mandatoryPasswordChangeDuration.

Certificate Login

Load your personal PKI certificate into your browser, selecting it if you hold more than one, then go to the Stroom UI URL. Provided you have an account, you are logged in without being asked for a password.

2 - Create a user

This HOWTO provides the steps to create a user via the Stroom User Interface.

Assumptions

The following assumptions are used in this document.

  • An account with the Administrator Application Permission is currently logged in.
  • We will be adding the user burn
  • We will make this user an Administrator

Add a New User

To add a new user, move your cursor to the Tools item of the Main Menu and select to bring up the Tools sub-menu.

images/HOWTOs/UI-ToolsSubmenu-00.png

Stroom UI Tools sub-menu

Then move down and select the Users and Groups sub-item to be presented with the Users and Groups configuration window as seen below.

images/HOWTOs/UI-AddUser-00.png

Stroom UI New User - Users and Groups configuration

To add the user, move the cursor to the New icon in the top left and select it. On selection you will be prompted for a user name. In our case we will enter the user burn.

images/HOWTOs/UI-AddUser-01.png

Stroom UI New User - Add User

and on pressing OK will be presented with the User configuration window.

images/HOWTOs/UI-AddUser-02.png

Stroom UI New User - User configuration

Set the User Application Permissions

See Permissions for an explanation of the various Application Permissions a user can have.

Assign an Administrator Permission

As we want the user to be an administrator, select the Administrator Permission check-box

images/HOWTOs/UI-AddUser-03.png

Stroom UI New User - User configuration - set administrator permission

Set User’s Password

We need to set burn's password (which he will need to reset on first login). So, select the Reset Password button to gain the Reset Password window

images/HOWTOs/UI-AddUser-04.png

Stroom UI New User - User configuration - reset password

After setting a password and pressing the OK button we get the informational Alert window as per

images/HOWTOs/UI-AddUser-05.png

Stroom UI New User - User configuration - reset password complete

and on close of the Alert we are presented again with the User configuration window.

images/HOWTOs/UI-AddUser-06.png

Stroom UI New User - User configuration - user added

We should close this window by pressing the Close button to be presented with the Users and Groups window with the new user burn added.

images/HOWTOs/UI-AddUser-07.png

Stroom UI New User - User configuration - show user added

At this point, one can close the Users and Groups configuration window by pressing the Close button at the bottom right of the window.

3 - Logout

This HOWTO shows how to log out of the Stroom User Interface.

Assumptions

The following assumptions are used in this document.

  • the user admin is currently logged in

Log Out of UI

To log out of the UI, select the User item of the Main Menu and to bring up the User sub-menu.

images/HOWTOs/UI-UserSubmenu-00.png

Stroom UI - User Sub-menu

and select the Logout sub-item and confirm you wish to log out by selecting the OK button.

images/HOWTOs/UI-UserLogout-00.png

Stroom UI - User Logout

This will return you to the Login page.

images/HOWTOs/UI-Login-00.png

Stroom UI Login Page