Users
UsersService provides operations for managing users.
Base path: /users
POST /users/ListUsers
Section titled “POST /users/ListUsers”ListUsers retrieves all users with pagination.
Request (ListUsersRequest)
| Field | Type | Description |
|---|---|---|
page_size | int32? | |
page_token | string? |
Response (ListUsersResponse)
| Field | Type | Description |
|---|---|---|
users | User[] | |
next_page_token | string |
POST /users/GetUser
Section titled “POST /users/GetUser”GetUser retrieves a specific user by ID.
Request (GetUserRequest)
| Field | Type | Description |
|---|---|---|
user_id | string |
Response (GetUserResponse)
| Field | Type | Description |
|---|---|---|
user | User |
POST /users/UpdateUser
Section titled “POST /users/UpdateUser”UpdateUser updates user properties (IsActive, IsAdmin, DisplayName).
Request (UpdateUserRequest)
| Field | Type | Description |
|---|---|---|
user_id | string | |
display_name | string? | |
is_active | bool? | |
is_admin | bool? |
Response (UpdateUserResponse)
| Field | Type | Description |
|---|---|---|
user | User |
POST /users/DeleteUser
Section titled “POST /users/DeleteUser”DeleteUser soft-deletes a user (sets IsDeleted=true).
Request (DeleteUserRequest)
| Field | Type | Description |
|---|---|---|
user_id | string |
Response (DeleteUserResponse)
No fields.
POST /users/ListUserAccounts
Section titled “POST /users/ListUserAccounts”ListUserAccounts lists all accounts owned by a user.
Request (ListUserAccountsRequest)
| Field | Type | Description |
|---|---|---|
user_id | string |
Response (ListUserAccountsResponse)
| Field | Type | Description |
|---|---|---|
accounts | accounts.v1.Account[] |
POST /users/GetUserOverview
Section titled “POST /users/GetUserOverview”GetUserOverview returns a UI-friendly, flattened view of a user and their primary mailbox context.
Request (GetUserOverviewRequest)
| Field | Type | Description |
|---|---|---|
user_id | string |
Response (GetUserOverviewResponse)
| Field | Type | Description |
|---|---|---|
user | User | |
primary_account | accounts.v1.Account | Present when the user has a primary_account_id. |
primary_account_aliases | aliases.v1.Alias[] | Aliases for the primary_account (admin view may include invisible/system aliases). |
accounts | accounts.v1.Account[] | Accounts owned by this user (current model); future membership/shared access can extend this. |