IRPCVault.GetUsersAndUserGroupsList
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the names of all users and user groups in one list, with group IDs negated.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/GetUsersAndUserGroupsList |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-users-and-user-groups-list |
| Request | GetUsersAndUserGroupsListRequest |
| Response | GetUsersAndUserGroupsListResponse |
| 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
Convenient for a picker: users have positive key values (the user ID), groups negative values
(minus the group ID). For example group 102 appears as -102.
Request: GetUsersAndUserGroupsListRequest
No fields.
Response: GetUsersAndUserGroupsListResponse
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 |
|---|---|---|
users_and_user_groups[] | repeated KeyNamePair | Users (positive key = user ID) followed by user groups (negative key = minus the group ID). |
users_and_user_groups[].key | int32 | The unique key of the item. |
users_and_user_groups[].name | string | The display name of the item. |
Related methods
- GetUsersAndUserGroups -- Gets all users and normal user groups of the vault as JSON.