4 Managing Users

Note

The user management is only available for the super admin.

4.1 Roles

OPENVAS SECURITY INTELLIGENCE uses a role-based access concept.

Super admin
  • This role has full access to OPENVAS SECURITY INTELLIGENCE and the entire Keycloak installation.

  • The initial user openvas is assigned this role.

  • This role should only be used for the initial setup and the user management.

Operator
  • This role has full access to OPENVAS SECURITY INTELLIGENCE.

  • This role does not have access to the user management.

User
  • This role has full read access to all data in its access scope.

  • This role does not have access to the user management and to application-wide settings.

4.2 Users

4.2.1 Viewing Users

All users can be displayed by selecting Settings > User Management in the menu.

For all users, the following information is displayed:

Username

Name that is used for signing in to OPENVAS SECURITY INTELLIGENCE.

Clicking on the name opens the details page of the user, where the user can be edited (see Chapter 4.2.3) and the password can be reset (see Chapter 4.2.5).

Email

E-mail address of the user.

Last name

Last name of the user.

First name

First name of the user.

When clicking the following action is available:

  • Delete the user (see Chapter 4.2.4).

4.2.2 Adding a User

A user can be added as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Click Add user.

    _images/add-user.png

    Fig. 4.1 Adding a user

  3. Fill in the input boxes:

    Required user actions

    Actions that the user must perform upon initial login, such as changing their password or updating their user profile.

    Select a locale

    User’s default language of OPENVAS SECURITY INTELLIGENCE.

    Username

    Name that is used for signing in to OPENVAS SECURITY INTELLIGENCE.

    The user name must be between three and 255 characters long. Only the following characters are allowed for the user name:

    • All lowercase English letters

    • Numbers 0–9

    • @ (at sign)

    • . (full stop)

    • - (dash)

    • _ (underscore)

    This input box is mandatory.

    E-mail address

    E-mail address of the user.

    First name

    First name of the user.

    Last name

    Last name of the user.

  4. Click Join Groups.

    Note

    The pre-defined sub-groups within the Platform group are used for role assignment. By adding users to one of the sub-groups, the respective role is assigned.

  5. Click for the Platform group.

  6. Activate the checkbox of the desired role.

    _images/add-user-2.png

    Fig. 4.2 Assigning a role to a user

  7. Click Groups to go back to the group overview.

    Note

    All other groups are sub-groups of the Custom group (see Chapter 4.3.1).

  8. Click for the Custom group.

  9. Activate the checkboxes for the desired groups.

  10. Click Join.

  11. Click Create.

    → The details page of the user is opened.

  12. Select the Credentials tab.

  13. Click Set password.

    _images/reset-pw-2.png

    Fig. 4.3 Setting a new password

  14. Enter a password for the new user and confirm it.

    Note

    The password must fulfill the criteria specified in the password policy (see Chapter 4.4).

  15. If the user should be forced to change the password when logging in for the first time, enable the toggle switch Temporary.

  16. Click Save.

  17. Click Save password to confirm.

    → The user can sign in to OPENVAS SECURITY INTELLIGENCE with the specified user name and password.

    Note

    If Temporary has been enabled, the user must change the password after signing in.

4.2.3 Editing a User

A user can be edited as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Click on the name of the user.

    _images/edit-user.png

    Fig. 4.4 Editing a user

  3. Update the required data.

  4. Click Save.

    → The user’s data in OPENVAS SECURITY INTELLIGENCE is updated.

4.2.4 Deleting a User

A user can be deleted as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Click in the row of the user and select Delete from the drop-down list.

    Note

    To delete multiple users at once, select the checkboxes of the users, click in the top bar, and select Delete user from the dropdown list.

    → A warning dialog is displayed asking to confirm the deletion.

    Note

    Deleting a user is irreversible. The user and all associated data is removed permanently.

    _images/delete-user.png

    Fig. 4.5 Confirming the deletion

  3. Click Delete.

    → The user is removed from OPENVAS SECURITY INTELLIGENCE.

4.2.5 Resetting the Password of a User

A user’s password can be reset by setting a temporary new password as follows:

A user can be edited as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Click on the name of the user.

  3. Select the Credentials tab.

    _images/reset-pw.png

    Fig. 4.6 Resetting a password

  4. Click Reset password in the row Password.

  5. Enter a new password in the input box and confirm it.

    Note

    The password must fulfill the criteria specified in the password policy (see Chapter 4.4).

    _images/reset-pw-2.png

    Fig. 4.7 Setting a new password

  6. If the user should be forced to change the password when logging in for the first time with the new password, enable the toggle switch Temporary.

  7. Click Save.

    → The user can sign in to OPENVAS SECURITY INTELLIGENCE with the new password.

    Note

    If Temporary has been enabled, the user must change the password after signing in.

4.3 Groups

Groups are used to logically assemble users.

4.3.1 Creating a Group

A group can be created as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Select Groups in the menu.

    _images/add-group.png

    Fig. 4.8 Creating a group

    Note

    All groups must be sub-groups of the Custom group.

  3. Click on the Custom group.

  4. Click Create group.

  5. Enter a name and a description for the group.

    _images/add-group-2.png

    Fig. 4.9 Creating a group

  6. Click Create.

4.3.2 Editing a Group

A group can be edited as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Select Groups in the menu.

  3. Click on the Custom group.

  4. Click on the name of the group that should be edited.

4.3.3 Deleting a Group

A group can be deleted as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Select Groups in the menu.

  3. Click on the Custom group.

  4. Click in the row of the group that should be deleted and select Delete from the drop-down list.

    Note

    To delete multiple groups at once, select the checkboxes of the groups, click in the top bar, and select Delete from the dropdown list.

    → A warning dialog is displayed asking to confirm the deletion.

    Note

    Deleting a group is irreversible. The group and all associated data is removed permanently.

    _images/delete-group.png

    Fig. 4.10 Confirming the deletion

  5. Click Delete.

    → The group is removed from OPENVAS SECURITY INTELLIGENCE.

4.3.4 Adding Users to a Group

Users can be added to a group as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Select Groups in the menu.

    Note

    The pre-defined sub-groups within the Platform group are used for role assignment. By adding users to one of the sub-groups, the respective role is assigned.

  3. Click on the name of the group/sub-group to which the users should be added.

  4. Select the Members tab.

    _images/group-member.png

    Fig. 4.11 Adding users to a group

  5. Click Add member.

  6. Activate the checkboxes of the users that should be added to the group.

  7. Click Add.

    → The users are displayed in the member list.

4.3.5 Removing Users from a Group

Users can be removed from a group as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Select Groups in the menu.

  3. Click on the name of the group/sub-group from which the users should be removed.

  4. Select the Members tab.

  5. Activate the checkboxes of the users that should be removed from the group.

  6. Click in the top bar and select Leave from the drop-down list.

    → The users are removed from the member list.

4.4 Configuring the Password Policy

The password policy specifies the requirements that login passwords must meet.

The password policy can be configured as follows:

  1. Select Settings > User Management in the menu.

    → The user management is opened in a new browser tab.

  2. Select Authentication in the menu.

  3. Select the Policies tab.

  4. Select the criteria for the password policy from the Add policy drop-down list.

    _images/password-policy.png

    Fig. 4.12 Selecting the criteria for the password policy

  5. Define the selected criteria.

    _images/password-policy-2.png

    Fig. 4.13 Defining the criteria

  6. Click Save.