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

Introduction

This new access method replaces the old admin_org controller and functions.

How Does it Work?

Orgs (organisations) in Open-AudIT are a key item. 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.

Most items in Open-AudIT are assigned to an Org. Devices, Locations, Networks, etc, etc.

Orgs can have child Orgs. Think of an organisational chart (tree) structure. If a user has access to a specific Org, they also have access to that Orgs descendants.

Creating an Organisation

To make another organisation go to menu: Manage -> Orgs -> Create Orgs.

 

 

View Organisation Details

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

You will see a list of organisations. You can view an organisation by clicking on the blue view button. You can also edit or delete your organisations.

 

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 "orgs" table.

Example Database Entry

Orgs are stored in the database in the "orgs" table. A typical entry will look as below.

API / Web Access

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

API Routes

Request Method
ID
Action
Resulting Function
URL Example
Notes
Example Response
GETn collection/orgsReturns a list of organisations.orgs_collection.json
GETy read/orgs/{id}Returns an organisation's details.orgs_read.json
PATCHy update/orgs/{id}Update an attribute of an organisations entry.orgs_patch.json
POSTn create/orgsInsert a new organisations entry.orgs_create.json
DELETEy delete/orgs/{id}Delete an organisations entry.orgs_delete.json

Web Application Routes

Request Method
ID
Action
Resulting Function
URL Example
Notes
GETncreatecreate_form/orgs/createDisplays a standard web form for submission to POST /orgs.
GETyupdateupdate_form/orgs/{id}/updateShow the networks details with the option to update attributes using PATCH to /orgs/{id}
  • No labels