Skip to main content
Version: 2.7

Add local users and groups

The procedures in this topic explain how you can create users and user groups in Portworx Backup Keycloak and view them in Portworx Backup Security of Portworx Backup web console.

Add users and user groups

Using the Portworx Backup Keycloak, you can add users and user groups in Portworx Backup. Additionally, when you integrate your OIDC provider into the Portworx Backup, all users and user groups that exist in your OIDC are added to the Portworx Backup. To view the added users and/or groups you have to navigate to Portworx Backup Security module of Portworx Backup web console.

note
  • If you have integrated an external authorization provider in Portworx Backup Keycloak, then you need not create local users and groups unless required.

  • Do not delete users and user groups that you added in the Keycloak.

Add users

To add users through Portworx Backup Keycloak:

  1. Login to Portworx Backup Keycloak using the infrastructure administrator credentials.

  2. In the Keycloak home page, select Administration Console.

  3. From the Master > Manage menu, select Users.

  4. In the Users page, click Add User:

    Keycloak Add User

  5. In the Create user page, enter the following fields:

    • Required user actions
    • Username
    • Email
    • Email verified
    • First Name
    • Last Name
    • Groups
  6. Click Join Groups if you want to make this user part of an existing group. Select the required group and click Join.

    note

    User's first name, last name, and email are mandatory for successful login.

  7. Click Create.

View users in Portworx Backup Security

All users that you added in the Portworx Backup Keycloak automatically appear in the Portworx Backup Security > Role Mapping > Users page of Portworx Backup web console:

Role Mapping Users

Add user groups

To add user groups using Portworx Backup Keycloak:

  1. Follow steps 1 and 2 in the above procedure to login to the Portworx Backup Keycloak.

  2. From the Master > Manage menu, select Groups.

  3. In the Groups page, click Create group.

    Keycloak Add Group

  4. In the Create a group window and in the Name text box, enter a user group name.

  5. Click Create.

After creating a user group, you can edit it to change the group name, add group attributes, map existing roles to the group, and members to the group.

View user groups in Portworx Backup Security

The user groups you added using the Portworx Backup Keycloak automatically appear in the Portworx Backup web console. To view the user groups in the Portworx Backup web console:

  1. From the home page, in the left navigation pane click User Profile > PX-Backup Security.

  2. Choose the Groups radio button in the Role Mapping page to view user groups.

Was this page helpful?