Table of Contents
*(Under Review for V2 - Not Completed Yet)
Introduction
The "Roles" endpoint allows you to manage the set of permissions(Create, Read, Update, Delete) that are granted to the users and are applied to each endpoint.
How Does it Work?
The primary method for authorisation authorization (what a user can do) is now based on the users' Roles. Roles are defined as admin, org_admin, reporter, and user by default. Each role has a set of permissions (Create, Read, Update, Delete) for each endpoint. Standard roles ( as shipped should cover 99.9% of use-cases. The ability to define additional roles and edit existing roles is enabled in Open-AudIT Enterprise.
Creating a Role Entry
Join Paul McClendon, an Opmantek Support Engineer, as he demonstrates how to create different roles in Open-AudIT.
Widget Connector width 600 url https://www.youtube.com/watch?v=frpHBkossXw height 400
A roles entry can be created using the web interface if the current user logged in has a defined role that contains the user::create permission. Go to menu: Manage -> Roles -> Create Roles. Also can be created from the Roles 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 grant permission to that user to access one or more organisationsorganizations. It is important to notice that selecting a parent organization will automatically provide access to its children.
View Role Details
...
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 details button for the table.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
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 | ||||
|---|---|---|---|---|
| ||||
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 |
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 |
|---|---|---|---|---|---|---|---|
| POST | n | create | roles::create | /roles | Insert a new role entry. | roles_create.json | |
| GET | y | read | roles::read | /roles/{id} | Returns a role details. | roles_read.json | |
| PATCH | y | update | roles::update | /roles/{id} | Update an attribute of a role entry. | roles_update.json | |
| DELETE | y | delete | roles::delete | /roles/{id} | Delete a role entry. | roles_delete.json | |
| GET | n | collection | roles::read | /roles | Returns a list of roles. | roles_collection.json |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | roles::create | /roles/create | Displays a standard web form for submission to POST /roles. |
| GET | y | update | update_form | roles::update | /roles/{id}/update | Show 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.