IRPCValueLists.GetValueListItemPermissions
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the permissions of one item of a plain value list.
| Service | Value lists MFiles.IRPCValueLists |
|---|---|
| gRPC method | /MFiles.IRPCValueLists/GetValueListItemPermissions |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-value-list-item-permissions |
| Request | GetValueListItemPermissionsRequest |
| Response | GetValueListItemPermissionsResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires read access to the item; otherwise fails with an access denied error.
- Not for real object types ("Not found."): get object permissions from IRPCObjectOperations.
Request: GetValueListItemPermissionsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
obj_id | ObjID | The item: type is the value list ID, item_id.internal_id the item ID. |
obj_id.type | int32 | The 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_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_id.item_id.internal_id | int32 | The ID of the object or value list item. |
obj_id.item_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
Response: GetValueListItemPermissionsResponse
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.
| Field | Type | Description |
|---|---|---|
putf8szacl | AccessControlList | The access control list of the item. |
putf8szacl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
putf8szacl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
putf8szacl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
putf8szacl.custom_component.named_acl_id | int32 | Specifies the named ACL link of this component. |
putf8szacl.custom_component.has_named_acl | bool | True if the component links to a named ACL (named_acl_id). |
putf8szacl.custom_component.current_user_id | int32 | Specifies the current user binding of this component. |
putf8szacl.custom_component.has_current_user | bool | True if the component has an access control entry for the current user. |
putf8szacl.custom_component.permissions[] | repeated AccessControlEntry | The access control entry datas. The data belongs to the key in the corresponding index. |
putf8szacl.custom_component.overridability_permissions[] | repeated AccessControlEntry | Overridability permission data of this ACL component. |
putf8szacl.custom_component.status | ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS | Modification status of this component. |
putf8szacl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
putf8szacl.restrictive_components[].key | AccessControlListComponentKey | Access control list component. |
putf8szacl.restrictive_components[].component | AccessControlListComponent | Access control list component. |
putf8szacl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
putf8szacl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
putf8szacl.additive_components[].key | AccessControlListComponentKey | Access control list component. |
putf8szacl.additive_components[].component | AccessControlListComponent | Access control list component. |
object_permissions | ObjectPermissionsForClient | What the calling user may do with the item. |
object_permissions.can_user_see | bool | The object is visible for the current user (provided for symmetry). |
object_permissions.can_user_edit | bool | The current user can edit the object. |
object_permissions.can_user_delete | bool | The current user can delete the object. |
object_permissions.can_user_change_permissions | bool | The current user can change the object permissions. |
Related methods
- GetValueList -- Gets one value list or object type by ID, without its icon.