Platform Explorer / Nuxeo Platform LTS 2017 9.10

Operation Document.AddACE (Set ACL)

Description

Set Acces Control Entry on the input document(s). Returns the document(s).
Operation id Document.AddACE
AliasesDocument.SetACE
Category Document
Label Set ACL
Requires
Since

Parameters

Name Description Type Required Default value
permission string yes  
user string yes  
acl string no local 
grant boolean no true 
overwrite boolean no true 

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "Document.AddACE",
  "aliases" : [ "Document.SetACE" ],
  "label" : "Set ACL",
  "category" : "Document",
  "requires" : null,
  "description" : "Set Acces Control Entry on the input document(s). Returns the document(s).",
  "url" : "Document.AddACE",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "permission",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "user",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "acl",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "local" ]
  }, {
    "name" : "grant",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "overwrite",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  } ]
}