IRPCNamedACLsAdmin.GetNamedACLsForAdmin
Administration API / specialized admin session idempotent
Gets the named ACLs of the given types, including the ACLs that control who sees them.
| Service | Named access control list administration MFiles.IRPCNamedACLsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCNamedACLsAdmin/GetNamedACLsForAdmin |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-named-acls-for-admin |
| Request | GetNamedACLsForAdminRequest |
| Response | GetNamedACLsForAdminResponse |
| 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 the vault right
read_all_metadata_structure. - Built-in named ACLs (negative IDs) are included. "Current user" entries are returned as such; they are not replaced with the caller's identity as in GetNamedACLs.
nacl_types0 returns an empty list. Names are in the session language. The order is not specified.
Request: GetNamedACLsForAdminRequest
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 |
|---|---|---|
nacl_types | uint32 | Which types to return, as a bit mask of NACLType values: 1 normal, 2 internal, 3 both. |
Response: GetNamedACLsForAdminResponse
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 |
|---|---|---|
values[] | repeated NamedACLAdmin | The named ACLs. See NamedACLAdmin. |
values[].named_acl | NamedACL | Basic data. |
values[].named_acl.id | int32 | Named ACL ID. |
values[].named_acl.name | string | The name of the named ACL. |
values[].named_acl.type | NACLType | The type of the NACL.Values: NACLTYPE_NONE (0), NACLTYPE_NORMAL (1), NACLTYPE_INTERNAL (2). |
values[].named_acl.acl_for_objects | AccessControlList | The predefined permissions. This defines the ACL which this named ACL encapsulates. |
values[].named_acl.guid | string | GUID for the NACL. |
values[].acl | AccessControlList | The permissions of this named ACL. This defines which users can see this named ACL, for example. |
values[].acl.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. |
values[].acl.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. |
values[].acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
values[].acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
values[].acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
values[].acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
values[].aliases | string | Semicolon-separated list of semantic aliases. |
Related methods
- IRPCNamedACLs.GetNamedACLs -- Gets the named ACLs of the given types that the calling user is allowed to see.