github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API guide to current 8/18/16

Browse Source 
- Modified "usershow" action to add "canremove": "false".
- Added new "groupmod" action with examples.
This commit is contained in:
Mrt134
2016-08-18 09:58:03 -04:00
parent 1fd947f5b4
commit dd34a97f57
1 changed files with 76 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
api/classes/users.rst
View File

@@ -6,25 +6,25 @@ users
The users class is used to manage users and groups on the system.
Every user request will have several parameters:
+----------------+------------+---------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+================+============+=======================================+
| id | | any unique value for the request; |
| | | examples include a hash, checksum, |
| | | or uuid |
+----------------+------------+---------------------------------------+
| name | users | |
| | | |
+----------------+------------+---------------------------------------+
| namespace | sysadm | |
| | | |
+----------------+------------+---------------------------------------+
| action | | "groupadd", "groupdelete", |
| | | "groupshow", "personacrypt_listdevs", |
| | | "useradd", "userdelete", "usermod", |
| | | "usershow" |
+----------------+------------+---------------------------------------+
+----------------+------------+----------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+================+============+========================================+
| id | | any unique value for the request; |
| | | examples include a hash, checksum, |
| | | or uuid |
+----------------+------------+----------------------------------------+
| name | users | |
| | | |
+----------------+------------+----------------------------------------+
| namespace | sysadm | |
| | | |
+----------------+------------+----------------------------------------+
| action | | "groupadd", "groupdelete", "groupmod", |
| | | "groupshow", "personacrypt_listdevs", |
| | | "useradd", "userdelete", "usermod", |
| | | "usershow" |
+----------------+------------+----------------------------------------+
.. index:: groupadd, users
@@ -119,6 +119,62 @@ Group Delete
"namespace": "sysadm"
}
.. index:: groupmod, users
.. _groupmod:
Group Modify
============
:command:`goupmod` modifies a given group on the system. There are two
required fields: "name": "<desired group>", and any **one** of three
choices:
* "users": ["<array of users>"] (will set the list of users for this
group).
* "add_users": ["<array of users>"] (will add the listed users to the
current users).
* "remove_users": ["<array of users>"] (will remove the listed users
from the current users).
**REST Request**
::
PUT sysadm/users
{
"action": "groupmod"
}
**WebSocket Request**
.. code-block:: json
{
"id":"sample",
"namespace":"sysadm",
"name":"users",
"args":{
"action":"groupmod",
"name":"operator",
"users":["user1","user2"]
}
}
**Response**
.. code-block:: json
{
"args": {
"result": "success"
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: groupshow, users
.. _groupshow:
@@ -471,6 +527,7 @@ system, regardless of active/inactive status.
{
"args": {
"_dhcp": {
"canremove": "false",
"change": "0",
"class": "",
"comment": "dhcp programs",