IRPCValueLists.CheckAccessToValueListItem
Vault API / core read session or assertion idempotent returns metadata structure version
Checks whether the calling user has the given access under an access control list that the caller supplies.
| Service | Value lists MFiles.IRPCValueLists |
|---|---|
| gRPC method | /MFiles.IRPCValueLists/CheckAccessToValueListItem |
| HTTP (mf-http-grpc) | POST /grpc/v1/check-access-to-value-list-item |
| Request | CheckAccessToValueListItemRequest |
| Response | CheckAccessToValueListItemResponse |
| 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
- Evaluates the ACL against the user's identity and group memberships, which the caller may not know. Nothing in the vault is changed.
allowedis unset (false) when the user lacks any of the requested rights.
Request: CheckAccessToValueListItemRequest
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 |
|---|---|---|
utf8szacl | AccessControlList | The access control list to evaluate, for example one returned by GetValueListItemPermissions. |
utf8szacl.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. |
utf8szacl.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. |
utf8szacl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
utf8szacl.custom_component.named_acl_id | int32 | Specifies the named ACL link of this component. |
utf8szacl.custom_component.has_named_acl | bool | True if the component links to a named ACL (named_acl_id). |
utf8szacl.custom_component.current_user_id | int32 | Specifies the current user binding of this component. |
utf8szacl.custom_component.has_current_user | bool | True if the component has an access control entry for the current user. |
utf8szacl.custom_component.permissions[] | repeated AccessControlEntry | The access control entry datas. The data belongs to the key in the corresponding index. |
utf8szacl.custom_component.overridability_permissions[] | repeated AccessControlEntry | Overridability permission data of this ACL component. |
utf8szacl.custom_component.status | ACCESSCONTROLLISTCOMPONENTSTATUSFLAGS | Modification status of this component. |
utf8szacl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
utf8szacl.restrictive_components[].key | AccessControlListComponentKey | Access control list component. |
utf8szacl.restrictive_components[].component | AccessControlListComponent | Access control list component. |
utf8szacl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
utf8szacl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
utf8szacl.additive_components[].key | AccessControlListComponentKey | Access control list component. |
utf8szacl.additive_components[].component | AccessControlListComponent | Access control list component. |
required | ObjectAccess | The rights to check, for example read or edit. All of them must be granted. |
required.all | bool | Specifies all flags set; Including any future flags. |
required.read | bool | Read. |
required.edit | bool | Edit. |
required.change_permissions | bool | Change security settings. |
required.delete_object | bool | Delete. |
required.attach_objects | bool | Attach objects. |
Response: CheckAccessToValueListItemResponse
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 |
|---|---|---|
allowed | bool | True if the user has all the required rights under the ACL. |