IRPCNamedACLsAdmin.RemoveNamedACL
Administration API / specialized admin session
Removes a named ACL from the vault.
| Service | Named access control list administration MFiles.IRPCNamedACLsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCNamedACLsAdmin/RemoveNamedACL |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-named-acl |
| Request | RemoveNamedACLRequest |
| Response | RemoveNamedACLResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Deletes the named ACL permanently. Objects keep their current permissions; with
allow_propagationtheir link to the named ACL is removed in a background task. - Requires the vault rights
change_metadata_structureandlicense_allows_modifications. - Fails if the named ACL is used in automatic permissions; check with IsNamedACLUsedInAutomaticPermissions.
- Changes the metadata structure version.
Request: RemoveNamedACLRequest
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 |
|---|---|---|
id | int32 | The ID of the named ACL to remove. |
allow_propagation | bool | True to remove the link from the objects that use the named ACL. False to fail the call instead if any object uses it. |
Response: RemoveNamedACLResponse
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 |
|---|---|---|
task_idchange_objects | int64 | The ID of the background task that updates the objects, or -1 if no objects needed changes. |
Related methods
- IsNamedACLUsedInAutomaticPermissions -- Tells whether a named ACL is used in the automatic permissions of any value list item or class.