Child pages
  • Users
Skip to end of metadata
Go to start of metadata

Introduction

The User endpoint allows you to manage user accounts within Open-AudIT.

How Does it Works?

A user has a primary Org as well as a list of Orgs they can access. A user combines this with a list of assigned 'Roles' that define what actions they can take on items assigned to the Orgs they have access to. The combination of a users 'orgs' and 'roles' define what they can and cannot do within Open-AudIT.

Creating a User Entry

A user entry can be created using the web interface if the current user logged in has a role that contains the user::create permission. Go to menu: Manage -> Users -> Create Users. Also can be created from the Users View, using the "Create" button.

To add a new user to Open-AudIT you have to provide the details of that person, assign the organization, select the relevant Roles (multiple roles can be selected), select if the user is active or not, etc. In addition, you must grand permission to that user to access one or more organisations. It is important to notice that selecting a parent organization will automatically provide access to its children.

 

 

View Users Details

Go to menu: Manage-> Users -> List Users.

You will see a list of users. You can view a user by clicking on the blue view icon. You can also edit or delete users.

 

 

Database Schema

The schema for the database is below. It can also be found in the application if the user has database::read permission by going to menu: Manage -> Database -> List, then clicking on the "users" table.

A typical entry looks as below.

API / Web Access

You can access the /users collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.

Access is provided as part of a roles permissions. Users is a standard resource and can have create, read, update and delete permissions.

The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).

API Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
Example Response
POSTn createusers::create/usersInsert a new user entry.users_create.json
GETy readusers::read/users/{id}Returns a user details.users_read.json
PATCHy updateusers::update/users/{id}Update an attribute of a user entry.users_update.json
DELETEy deleteusers::delete/users/{id}Delete a user entry.users_delete.json
GETn collectionusers::read/usersReturns a list of users.users_collection.json

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formusers::create/users/createDisplays a standard web form for submission to POST /users.
GETyupdateupdate_formusers::update/users/{id}/updateShow the user details with the option to update attributes using PATCH to /users/{id}

 

 

 

 

  • No labels