HomeDocumentationAPI Reference
Log In
These docs are for v16. Click to read the latest docs for v33.

Creating Local Users and Roles

Create users in PrivX, which allows people to log into hosts via PrivX:

  1. Navigate to the address of the PrivX server and log in as ​superuser​​.
    PrivX login page

  2. In the PrivX GUI, navigate to the ​Settings→Users​ page and click ​Add User​​.
    Settings->Users page with Add User button highlighted
    You will be presented with the ​New User​​ view.

  3. In the ​New User​ view, provide the required information about the user. Click ​Save​​ to save the user.
    New User page with basic user fields filled in, including: username, password & verify password, full name, and email

    You should now be able to see your new local user back on the ​Settings→Users​​ page.
    Users page displaying the newly created

PrivX provides access in a role-based manner. To create a role and assign members:

  1. In the PrivX GUI, navigate to the ​Settings→Roles​ page, and click ​Add Role​​.

    You will be presented with a form for providing information about the new role.

    Add Role view with one rule where directory is set to Local users and Search string is set to (cn=alice)

  2. Provide a name for the new role. Also add users to the role by defining rules. To define a new rule for the role, click ​Add Rule​​. In this example, we add a rule to include all local users who have the user name (cn) ​alice​​ into the role:

    Add Role view with Matching users showing one match

    📘

    Note

    The number of role members is indicated by ​Matching users​​. The count is updated when you unfocus from the ​Search String​​ field (such as by pressing enter, or by clicking somewhere else in the GUI).

    Leave the other role settings as they are.

  3. Click ​Save​ to finalize role creation. Your new role should be visible back on the ​Settings→Roles​​ page.

    Dropdown menu next to the role. The List Members choice is highlighted in the dropdown menu
    Role members view listing alice as a member