Platform Explorer / Nuxeo Platform 6.0

Operation Document.AddPermission

Add Permission

Description

Add Permission on the input document(s). Returns the document(s).
Operation id Document.AddPermission
Category Document
Label Add Permission
Requires
Since

Parameters

Name Description Type Required Default value
permission string yes  
user string yes  
acl string no local 
blockInheritance boolean no  

Signature

Inputs document, documents
Outputs document, documents

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.document.AddPermission
Contributing component org.nuxeo.ecm.core.automation.coreContrib

JSON definition

{
  "id" : "Document.AddPermission",
  "aliases" : [ "Document.AddACL" ],
  "label" : "Add Permission",
  "category" : "Document",
  "requires" : null,
  "description" : "Add Permission on the input document(s). Returns the document(s).",
  "url" : "Document.AddPermission",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "permission",
    "description" : "ACE permission.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "acl",
    "description" : "ACL name.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "local" ]
  }, {
    "name" : "begin",
    "description" : "ACE begin date.",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "blockInheritance",
    "description" : "Block inheritance or not.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "comment",
    "description" : "Comment",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "email",
    "description" : "ACE target user/group.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "end",
    "description" : "ACE end date.",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "notify",
    "description" : "Notify the user or not",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : "ACE target user/group.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "users",
    "description" : "ACE target set of users and/or groups.",
    "type" : "list",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}