Named access control list administration (IRPCNamedACLsAdmin)
Adds, reads, modifies and removes the named access control lists (permission templates) of a vault.
Use this interface to add, modify and delete named ACLs in a vault.
| gRPC service | MFiles.IRPCNamedACLsAdmin |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 5 |
| Proto file | mfiles/IRPCNamedACLsAdmin.proto |
Overview
A named ACL is a reusable set of permissions with a name, such as "Visible to company management only". Users pick one when they set the permissions of an object; value list items and classes can apply one automatically. See Permissions. M-Files Admin uses this service for the Named access control lists node of a vault.
- Session and rights. Requires a vault session. Reading needs the vault right
read_all_metadata_structure(VaultAccess); adding, modifying and removing needchange_metadata_structureandlicense_allows_modifications. - Two ACLs per named ACL (NamedACLAdmin):
named_acl.acl_for_objectsis the permission set that objects get;aclcontrols who can see and select the named ACL. - Types.
NACLTYPE_NORMALnamed ACLs are offered to users.NACLTYPE_INTERNALnamed ACLs hold automatic permissions defined on value list items and classes, and are not offered to users. - Built-in named ACLs have negative IDs, for example -1 "Full control for all internal users" and -20 "Only for me".
- Objects that use a named ACL stay linked to it: modifying the named ACL can update their permissions in the background, see ModifyNamedACL.
Users who are not administrators read the named ACLs they can select with GetNamedACLs.
Methods
| Method | Summary | Facts |
|---|---|---|
| AddNamedACL | Adds a named ACL to the vault. | admin session |
| GetNamedACLsForAdmin | Gets the named ACLs of the given types, including the ACLs that control who sees them. | admin session idempotent |
| IsNamedACLUsedInAutomaticPermissions | Tells whether a named ACL is used in the automatic permissions of any value list item or class. | admin session idempotent |
| ModifyNamedACL | Changes a named ACL, and optionally the permissions of the objects that use it. | admin session idempotent |
| RemoveNamedACL | Removes a named ACL from the vault. | admin session |