IRPCVault.GetGroupsOfUserOrGroup
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the user groups that a user or a user group belongs to.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/GetGroupsOfUserOrGroup |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-groups-of-user-or-group |
| Request | GetGroupsOfUserOrGroupRequest |
| Response | GetGroupsOfUserOrGroupResponse |
| 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) |
Request: GetGroupsOfUserOrGroupRequest
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 |
|---|---|---|
user_or_group_id | int32 | The ID of the user, or of the user group when is_group is true. |
is_group | bool | True if user_or_group_id is a user group ID; false (default) for a user ID. |
Response: GetGroupsOfUserOrGroupResponse
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 |
|---|---|---|
groups[] | repeated UserGroupBasic | User groups (represented by UserGroupBasic structs). |
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). |