Class Index

Classes


AclManager_PUT

Creates or updates acls
Defined in: aclManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
AclManager_PUT(acls, pretty)
PUT /wf/restapi/v2/admin/aclManager: This endpoint creates acls or updates existing acls.
Class Detail
AclManager_PUT(acls, pretty)
PUT /wf/restapi/v2/admin/aclManager: This endpoint creates acls or updates existing acls.
Parameters:
acls
An array of acl objects to create. These objects should have the same structure as collected from AclManager_GET. If you are creating a new acl the "id" parameter is not required, but it is required to update an existing acl.
pretty Optional, Default: false
format the response to be human readable?
PUT /wf/restapi/v2/admin/aclManager (Creating a new acl)
Body form-data:

acls =
 [
  {
    "description": "this acl test creating an acl",
    "name": "TestAcl",
    "hidden": false,
    "groupId": 6,
    "revokedPermissions": [],
    "rootPath": "",
    "workspaces": [ ],
    "searchFilter": null,
    "forms": [
      "XMP Basic"
    ],
    "uploadForm": ""
  }
 ]

 Response:
 [
  {
    "description": "this acl test creating an acl",
    "id": "0_6_8A07B49F-2CC5-4DFB-ACD5-B9C9A8F03333",
    "name": "TestAcl",
    "hidden": false,
    "groupId": 6,
    "revokedPermissions": [],
    "rootPath": "",
    "workspaces": [
      "F90B0A3A-AA51-4A0F-A806-C6EAEA7B41C2"
    ],
    "searchFilter": null,
    "forms": [
      "XMP Basic"
    ],
    "uploadForm": ""
  }
 ]
PUT /wf/restapi/v2/admin/aclManager (Modify the acl from the previous example)
Body form-data:

acls =
 [
  {
    "description": "new description",
    "id": "0_6_8A07B49F-2CC5-4DFB-ACD5-B9C9A8F03333",
    "name": "newName",
    "hidden": false,
    "groupId": 6,
    "revokedPermissions": [],
    "rootPath": "",
    "workspaces": [
      "F90B0A3A-AA51-4A0F-A806-C6EAEA7B41C2"
    ],
    "searchFilter": null,
    "forms": [
      "XMP Basic"
    ],
    "uploadForm": "XMP Basic"
  }
 ]

 Response:
 [
  {
    "description": "new description",
    "id": "0_6_8A07B49F-2CC5-4DFB-ACD5-B9C9A8F03333",
    "name": "newName",
    "hidden": false,
    "groupId": 6,
    "revokedPermissions": [],
    "rootPath": "",
    "workspaces": [
      "F90B0A3A-AA51-4A0F-A806-C6EAEA7B41C2"
    ],
    "searchFilter": null,
    "forms": [
      "XMP Basic"
    ],
    "uploadForm": "XMP Basic"
  }
 ]

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