users
Protocol buffer definition for users
sift/users/v2/users.proto
GetUserRequest
The request for a call to retrieve a single existing user by its user_id.
Field | Type | Label | Description |
---|---|---|---|
user_id | string | The id of the asset to be retrieved. Required. |
GetUserResponse
Field | Type | Label | Description |
---|---|---|---|
user | sift.common.type.v1.User |
ListActiveUsersRequest
The request for a call to UserService_ListActiveUsers
to retrieve users.
Field | Type | Label | Description |
---|---|---|---|
page_size | uint32 | The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
page_token | string | A page token, received from a previous ListActiveUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListActiveUsers must match the call that provided the page token. Optional. | |
filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are user_id and name . For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
organization_id | string | Optional. If provided, this will scope down the user search to just those in the organization ID provided. |
ListActiveUsersResponse
The response of a call to UserService_ListActiveUsersResponse
.
Field | Type | Label | Description |
---|---|---|---|
users | sift.common.type.v1.User | repeated | |
next_page_token | string |
UpdateUserOrganizationActiveRequest
UpdateUserOrganizationActiveResponse
UserService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
UpdateUserOrganizationActive | UpdateUserOrganizationActiveRequest | UpdateUserOrganizationActiveResponse | Used to toggle a user's active status within their organization. |
GetUser | GetUserRequest | GetUserResponse | Retrieves a user object. |
ListActiveUsers | ListActiveUsersRequest | ListActiveUsersResponse | List active users. |