Once logged in as an admin, you can manage users using the WAF's Authentication API located at https://<your-hostname>/auth/users.

Navigating to this endpoint in your browser as an admin will show you a list of users.

Create User

Create user swagger endpoint
Create user swagger endpoint

The create user POST endpoint takes a request object like:

{
  "username": "string",
  "fullname": "string",
  "password": "string",
  "email": "string",
  "admin": false
}

With the swagger endpoint selected, click the Try it out button on the right at the top of the section.

Edit the request object to include the information for the new user, then click Execute to create the user.

Note that creating a user via the authentication API creates a local Portal user. See basic authentication for more information.

List All Users

List all users swagger endpoint
List all users swagger endpoint

As mentioned above you can load this endpoint (https://<your-hostname>/auth/users) in your browser. Alternatively you can try the endpoint using the swagger docs. With the swagger endpoint selected click Try it out, then click Execute

Edit/Update User

Update user swagger endpoint
Update user swagger endpoint

To edit an existing user, you will first need to get the user's id from the /auth/users endpoint.

In addition to the user's id, the update endpoint expects the following request object:

{
  "username": "string",
  "fullname": "string",
  "password": "string",
  "email": "string",
  "admin": false
}

With the endpoint selected, click Try it out then enter the user's id. Edit the request object with the updated user's information and click Execute.

Promoting a User to Admin

Use the /auth/users endpoint with a GET request to find the specific user's id.

Use the /auth/users/{user_id} endpoint with a PUT request and the specific user's id and the following request object:

{
  "admin": true
}

Delete User

Delete user swagger endpoint
Delete user swagger endpoint

To delete an existing user, you will first need to get the user's id from the /auth/users endpoint.

With the delete endpoint selected, click Try it out and enter the user's id. Clicking Execute will delete the user. You will not get a confirm dialogue.