user_groups
Protocol buffer definition for user_groups
sift/user_groups/v2/user_groups.proto
AddUserToUserGroupRequest
AddUserToUserGroupResponse
CreateUserGroupRequest
| Field | Type | Label | Description |
|---|---|---|---|
| user_group | UserGroup |
CreateUserGroupResponse
| Field | Type | Label | Description |
|---|---|---|---|
| user_group | UserGroup |
DeleteUserGroupRequest
| Field | Type | Label | Description |
|---|---|---|---|
| user_group_id | string |
DeleteUserGroupResponse
GetUserGroupRequest
| Field | Type | Label | Description |
|---|---|---|---|
| user_group_id | string |
GetUserGroupResponse
| Field | Type | Label | Description |
|---|---|---|---|
| user_group | UserGroup |
GetUserGroupsForAssetsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| asset_ids | string | repeated |
GetUserGroupsForAssetsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| user_groups | UserGroup | repeated | |
| roles | sift.roles.v2.Role | repeated |
ListUserGroupsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of user groups to return. The service may return fewer than this value. If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListUserGroups call. Provide this to retrieve the subsequent page. |
When paginating, all other parameters provided to ListUserGroups must match the call that provided the page token. |
| filter | string | | A Common Expression Language (CEL, https://github.com/google/cel-spec) filter string. Available tag variables are: - name |
| order_by | string | | How to order the retrieved user groups. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are: - created_date - modified_date |
ListUserGroupsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| user_groups | UserGroup | repeated | |
| next_page_token | string | A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages. |
RemoveUserFromUserGroupRequest
RemoveUserFromUserGroupResponse
UpdateUserGroupRequest
| Field | Type | Label | Description |
|---|---|---|---|
| user_group | UserGroup | ||
| update_mask | google.protobuf.FieldMask | The list of fields to update. |
UpdateUserGroupResponse
| Field | Type | Label | Description |
|---|---|---|---|
| user_group | UserGroup |
UpdateUserUserGroupsRequest
UpdateUserUserGroupsResponse
UserGroup
| Field | Type | Label | Description |
|---|---|---|---|
| user_group_id | string | ||
| name | string | ||
| role_id | string | ||
| is_default | bool | ||
| resources | UserGroup.Resource | ||
| user_ids | string | repeated |
UserGroup.Resource
UserGroupService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ListUserGroups | ListUserGroupsRequest | ListUserGroupsResponse | |
| GetUserGroup | GetUserGroupRequest | GetUserGroupResponse | |
| CreateUserGroup | CreateUserGroupRequest | CreateUserGroupResponse | |
| UpdateUserGroup | UpdateUserGroupRequest | UpdateUserGroupResponse | |
| DeleteUserGroup | DeleteUserGroupRequest | DeleteUserGroupResponse | |
| AddUserToUserGroup | AddUserToUserGroupRequest | AddUserToUserGroupResponse | |
| RemoveUserFromUserGroup | RemoveUserFromUserGroupRequest | RemoveUserFromUserGroupResponse | |
| UpdateUserUserGroups | UpdateUserUserGroupsRequest | UpdateUserUserGroupsResponse | |
| GetUserGroupsForAssets | GetUserGroupsForAssetsRequest | GetUserGroupsForAssetsResponse |