IRPCVault.GetUsersAndUserContainers
Vault API / core read session or assertion idempotent returns metadata structure version
Gets all users and all user groups of the vault.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/GetUsersAndUserContainers |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-users-and-user-containers |
| Request | GetUsersAndUserContainersRequest |
| Response | GetUsersAndUserContainersResponse |
| 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
The typed way to list users and groups. users gives each user's ID (key) and full name;
groups gives each group with its members (user IDs and group IDs). Includes groups of all
types, unlike GetUserGroups.
Request: GetUsersAndUserContainersRequest
No fields.
Response: GetUsersAndUserContainersResponse
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[] | repeated KeyNamePair | The users: key is the user ID, name the full name. |
users[].key | int32 | The unique key of the item. |
users[].name | string | The display name of the item. |
groups[] | repeated UserGroupBasic | The user groups with their members. |
groups[].id | int32 | The ID of the user group. |
groups[].name | string | The name of the group. |
groups[].members[] | repeated int32 | The IDs of the members of this group (user accounts and/or user groups). |
groups[].type | UserGroupType | User group type.Values: USER_GROUP_TYPE_NORMAL (0), USER_GROUP_TYPE_REPOSITORY_USER (1), USER_GROUP_TYPE_REPOSITORY_GROUP (2), USER_GROUP_TYPE_ANY (-1). |
Related methods
- GetUserGroups -- Gets the vault's normal user groups with their members.
- GetUsersAndUserContainersOrDelta -- Gets users and user groups of all types as JSON, or only the changes since a version the caller already has.