Skip to content

Creating additional users

Brad Woodward edited this page Dec 31, 2020 · 5 revisions

Adding users to an existing NPK deployment

NPK is designed for multi-tenancy, where multiple users can use the platform simultaneously. Uploaded hashes, campaign configurations, and results are strictly segmented to ensure that these are accessible only to the user who owns them.

NPK uses AWS Cognito for managing user accounts and authentication, which makes adding a new user very easy. This can be accomplished either through the NPK User Management view, or directly via AWS Cognito.

Using the NPK User Management view

Administrators in NPK can create new users via the User Management view, accessible from the sidebar, and clicking 'Add User'.

Image

You will then be presented with a 'New User' modal, which prompts for the new user's email address, and whether they should be created as an Administrator user. Provide the requested details, and click 'Save'.

Image

The user will then be sent an invitation email, containing their username, temporary password, and a link to the NPK UI. Other user administration actions can be performed using the 'Tools' buttons next to each user. Only the available actions are shown, and hovering over each button will show the action it will perform. Actions include promoting and demoting administrators; enabling, disabling, and deleting user accounts; and resetting a user's password.

Image

Using AWS Cognito

To add a new user, open the AWS Console and browse to the Cognito service. Make sure you're in the us-west-2 region, and click 'Manage User Pools'.

Image

Select the 'NPK' user pool, select the 'Users and Groups' link in the sidebar, and click the 'Create User' button.

Image

In the 'Create User' dialog, do the following:

  1. Enter the email address for the new user as the 'Username'.
  2. Ensure that 'Send and Invitation' is checked, along with 'Email'.
  3. Leave 'Temporary password' and 'Phone Number' blank.
  4. Re-enter the email address under 'Email'
  5. Check 'Mark email as Verified?'

When finished, the 'Create user' dialog should look like this:

Image

Then click 'Create user'. This will create the user in Cognito, and send the user and invitation matching the one you received when first provisioning NPK. Have the user follow the instructions to log in and set a new password, after which they'll be able to use NPK in its entirety.

To promote a user to an administrator role within NPK via Cognito, simply add the user's name to the 'NPK Admins' Group under the 'Groups' tab.