Class Index

Classes


GroupManager_DELETE

Removes groups
Defined in: groupManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GroupManager_DELETE(groups, pretty)
DELETE /wf/restapi/v2/admin/groupManager: Removes groups from MediaBeacon
Class Detail
GroupManager_DELETE(groups, pretty)
DELETE /wf/restapi/v2/admin/groupManager: Removes groups from MediaBeacon
Parameters:
groups
An array of group objects to remove. These objects can have the same structure as collected from GroupManager_GET, but only require "id" or "name".
pretty Optional, Default: false
format the response to be human readable?
DELETE /wf/restapi/v2/admin/groupManager
Body form-data:
groups =
 [
    {
        "loadingDockType": 1,
        "hidden": false,
        "description": "Group to test modifying",
        "ldapDn": "",
        "priority": 1,
        "editLevel": 5,
        "loginText": "this is displayed on login",
        "viewLevel": 5,
        "name": "New Group rename",
        "id": 9,
        "acls": [],
        "users": [
            2
        ]
    },
    {
        "name": "Delete by name"
    },
    {
        "id": 11
    }
 ]
Response:
 [
    {
        "loadingDockType": 1,
        "hidden": false,
        "description": "Group to test modifying",
        "ldapDn": "",
        "priority": 1,
        "editLevel": 5,
        "loginText": "this is displayed on login",
        "viewLevel": 5,
        "name": "New Group rename",
        "id": 9,
        "acls": [],
        "users": []
    },
    {
        "loadingDockType": 1,
        "hidden": false,
        "description": "",
        "ldapDn": "",
        "priority": 1,
        "editLevel": 5,
        "loginText": "",
        "viewLevel": 5,
        "name": "Delete by name",
        "id": 10,
        "acls": [],
        "users": []
    },
    {
        "loadingDockType": 1,
        "hidden": false,
        "description": "",
        "ldapDn": "",
        "priority": 1,
        "editLevel": 5,
        "loginText": "",
        "viewLevel": 5,
        "name": "Delete by id",
        "id": 11,
        "acls": [],
        "users": []
    }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:02 GMT-0600 (CST)