IRPCValueLists.ChangeValueListItemPermissionsFromClient

View as Markdown

Vault API / core write session or assertion idempotent returns metadata structure version

Changes the permissions of a traditional folder.

ServiceValue lists MFiles.IRPCValueLists
gRPC method/MFiles.IRPCValueLists/ChangeValueListItemPermissionsFromClient
HTTP (mf-http-grpc)POST /grpc/v1/change-value-list-item-permissions-from-client
RequestChangeValueListItemPermissionsFromClientRequest
ResponseChangeValueListItemPermissionsFromClientResponse
Book and levelVault API, core
Kindwrite
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: ChangeValueListItemPermissionsFromClientRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.

FieldTypeDescription
obj_idObjIDThe folder: type 4 and the folder's item ID.
obj_id.typeint32The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID).
obj_id.item_idItemIDThe ID of the object within its type, in item_id.internal_id.
obj_id.item_id.internal_idint32The ID of the object or value list item.
obj_id.item_id.external_repository_idExternalRepositoryIDUsed only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault.
aclAccessControlListThe new access control list of the folder.
acl.checked_out_to_userint32Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist.
acl.is_fully_authoritativeboolSpecifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version.
acl.custom_componentAccessControlListComponentAccesses the custom component of this ACL.
acl.custom_component.named_acl_idint32Specifies the named ACL link of this component.
acl.custom_component.has_named_aclboolTrue if the component links to a named ACL (named_acl_id).
acl.custom_component.current_user_idint32Specifies the current user binding of this component.
acl.custom_component.has_current_userboolTrue if the component has an access control entry for the current user.
acl.custom_component.permissions[]repeated AccessControlEntryThe access control entry datas. The data belongs to the key in the corresponding index.
acl.custom_component.overridability_permissions[]repeated AccessControlEntryOverridability permission data of this ACL component.
acl.custom_component.statusACCESSCONTROLLISTCOMPONENTSTATUSFLAGSModification status of this component.
acl.restrictive_components[]repeated AccessControlListComponentMapEntryAccesses the restrictive automatic components of this ACL.
acl.restrictive_components[].keyAccessControlListComponentKeyAccess control list component.
acl.restrictive_components[].componentAccessControlListComponentAccess control list component.
acl.secondary_access_control_listAccessControlList (recursive)Secondary ACL used for latest version ACL. Not used for access check if null.
acl.additive_components[]repeated AccessControlListComponentMapEntryAccesses the additive automatic components of this ACL.
acl.additive_components[].keyAccessControlListComponentKeyAccess control list component.
acl.additive_components[].componentAccessControlListComponentAccess control list component.

Response: ChangeValueListItemPermissionsFromClientResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
visibleboolTrue if the caller can still see the folder after the change.