Skip to main content
No description provided.

Messages

Data models used across requests/responses.

AddUserToUserGroupRequest

No description provided.
FieldTypeLabelDescription
user_group_idstring
user_idstring

AddUserToUserGroupResponse

No description provided. This message has no fields.

CreateUserGroupRequest

No description provided.
FieldTypeLabelDescription
user_groupUserGroup

CreateUserGroupResponse

No description provided.
FieldTypeLabelDescription
user_groupUserGroup

DeleteUserGroupRequest

No description provided.
FieldTypeLabelDescription
user_group_idstring

DeleteUserGroupResponse

No description provided. This message has no fields.

GetUserGroupRequest

No description provided.
FieldTypeLabelDescription
user_group_idstring

GetUserGroupResponse

No description provided.
FieldTypeLabelDescription
user_groupUserGroup

GetUserGroupsForAssetsRequest

No description provided.
FieldTypeLabelDescription
asset_idsstringrepeated

GetUserGroupsForAssetsResponse

No description provided.
FieldTypeLabelDescription
user_groupsUserGrouprepeated
rolessift.roles.v2.Rolerepeated

ListUserGroupsRequest

No description provided.
FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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 name, created_date, and modified_date. If left empty, items are ordered by name in ascending order (A-Z). For more information about the format of this field, read this Example: “created_date desc,modified_date” |

ListUserGroupsResponse

No description provided.
FieldTypeLabelDescription
user_groupsUserGrouprepeated
next_page_tokenstringA token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

RemoveUserFromUserGroupRequest

No description provided.
FieldTypeLabelDescription
user_group_idstring
user_idstring

RemoveUserFromUserGroupResponse

No description provided. This message has no fields.

UpdateUserGroupRequest

No description provided.
FieldTypeLabelDescription
user_groupUserGroup
update_maskgoogle.protobuf.FieldMaskThe list of fields to update.

UpdateUserGroupResponse

No description provided.
FieldTypeLabelDescription
user_groupUserGroup

UpdateUserUserGroupsRequest

No description provided.
FieldTypeLabelDescription
user_idstring
user_group_idsstringrepeated

UpdateUserUserGroupsResponse

No description provided. This message has no fields.

UserGroup

No description provided.
FieldTypeLabelDescription
user_group_idstring
namestring
role_idstring
is_defaultbool
resourcesUserGroup.Resource
user_idsstringrepeated
is_externalbool

UserGroup.Resource

No description provided.
FieldTypeLabelDescription
asset_idsstringrepeated
all_assetsbool

Enums

Allowed constant values used in message fields.

Services

RPC methods exposed by this API.

UserGroupService

No description provided.