IRPCObjectTypesAdmin.ChangeObjectTypeItemPermissions
Administration API / specialized admin session idempotent
Replaces the permissions (ACL) of a value list item.
| Service | Object type administration MFiles.IRPCObjectTypesAdmin |
|---|---|
| gRPC method | /MFiles.IRPCObjectTypesAdmin/ChangeObjectTypeItemPermissions |
| HTTP (mf-http-grpc) | POST /grpc/v1/change-object-type-item-permissions |
| Request | ChangeObjectTypeItemPermissionsRequest |
| Response | ChangeObjectTypeItemPermissionsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires
change_metadata_structureandlicense_allows_modifications. - Only for items of plain value lists; change object permissions with the object operations.
- For items of the structure lists (classes, class groups, workflows, states, state transitions, external locations) the change increments the metadata structure version.
Request: ChangeObjectTypeItemPermissionsRequest
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 |
|---|---|---|
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. |
utf8szacl | AccessControlList | The new AccessControlList of the item. |
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. |
Response: ChangeObjectTypeItemPermissionsResponse
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 |
|---|---|---|
visible | bool | True if the caller can still see the item under the new ACL. |