Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You will see a list of roles. You can view a role by clicking on the blue view icon. You can also edit or delete roles (except standard roles).


Database Schema

The database schema

...

can

...

be found in the application is the user has database::read permission by going to menu: Admin -> Database -> List Tables, then clicking on the

...

Code Block
languagetext
themeEclipse
CREATE TABLE `roles` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(200) NOT NULL DEFAULT '',
  `description` text NOT NULL,
  `permissions` text NOT NULL,
  `ad_group` varchar(100) NOT NULL DEFAULT '',
  `edited_by` varchar(200) NOT NULL DEFAULT '',
  `edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;

A typical entry looks as below.

Code Block
languagetext
themeEclipse
         id: 1
       name: admin
description: This role can change global options.
permissions: {"attributes":"crud","baselines":"crud","configuration":"crud","database":"crud","errors":"r","groups":"crud","ldap_servers":"crud","logs":"crud","nmis":"crud","queries":"crud","reports":"r","roles":"crud","search":"crud","sessions":"crud","summaries":"crud","tasks":"crud"}
   ad_group: open-audit_roles_admin
  edited_by: system
edited_date: 2000-01-01 00:00:00

details button for the table.


API / Web Access

You can access the

...

collection using the normal Open-AudIT JSON based API. Just like any other collection. Please

...

see The Open-AudIT API documentation for further details.

Access is provided as part of a roles permissions. Roles 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

...


...

Web Application Routes

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

Default Items

Shipped are a set of default items. These can be found by going to menu: Help → Defaults → Roles.