IRPCVault.GetUserGroup
Vault API / core write session or assertion returns metadata structure version
Gets one user group with its members.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/GetUserGroup |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-user-group |
| Request | GetUserGroupRequest |
| Response | GetUserGroupResponse |
| Book and level | Vault API, core |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Request: GetUserGroupRequest
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_group | int32 | The ID of the user group (positive). |
Response: GetUserGroupResponse
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 |
|---|---|---|
putf8szugb | UserGroupBasic | The user group, with its name, type and members. |
putf8szugb.id | int32 | The ID of the user group. |
putf8szugb.name | string | The name of the group. |
putf8szugb.members[] | repeated int32 | The IDs of the members of this group (user accounts and/or user groups). |
putf8szugb.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). |