Tiyi v3.8.0

user.proto — Users, roles, and permissions

Schema: tiyi.v1 · user.proto · English guide · 中文指南 · Full RPC index

Services

UserService

RPC	Kind	Required permission
`ListUsers`	unary	(`user:read`)
`GetUser`	unary	(`user:read`)
`CreateUser`	unary	(`user:write`)
`UpdateUser`	unary	(`user:write`)
`DeleteUser`	unary	(`user:delete`)
`AssignRoles`	unary	(`user:write`)
`ResetPassword`	unary	(`user:write`)
`LockUser`	unary	(`user:write`)
`UnlockUser`	unary	(`user:write`)
`ResetUserMFA`	unary	(`user:write`)

RoleService

RPC	Kind	Required permission
`ListRoles`	unary	(`role:read`)
`GetRole`	unary	(`role:read`)
`CreateRole`	unary	(`role:write`)
`UpdateRole`	unary	(`role:write`)
`DeleteRole`	unary	(`role:delete`)
`ListPermissions`	unary	(`role:read`)

RPCs

UserService.ListUsers

Procedure POST /tiyi.v1.UserService/ListUsers
Kind unary
Auth (user:read)

Request — tiyi.v1.ListUsersRequest

Field	JSON key	Type	Cardinality	Description
`page`	`page`	`PageRequest`	singular	—
`query`	`query`	`string`	singular	—
`role_id`	`roleId`	`string`	singular	—
`locked`	`locked`	`bool`	optional (explicit)	—

Response — tiyi.v1.ListUsersResponse

Field	JSON key	Type	Cardinality	Description
`items`	`items`	`User`	repeated	—
`page`	`page`	`PageResponse`	singular	—

UserService.GetUser

Procedure POST /tiyi.v1.UserService/GetUser
Kind unary
Auth (user:read)

Request — tiyi.v1.GetUserRequest

Field	JSON key	Type	Cardinality	Description
`id`	`id`	`string`	singular	—

Response — tiyi.v1.GetUserResponse

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—

UserService.CreateUser

Procedure POST /tiyi.v1.UserService/CreateUser
Kind unary
Auth (user:write)

Request — tiyi.v1.CreateUserRequest

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—
`password`	`password`	`string`	singular	—

Response — tiyi.v1.CreateUserResponse

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—

UserService.UpdateUser

Procedure POST /tiyi.v1.UserService/UpdateUser
Kind unary
Auth (user:write)

Request — tiyi.v1.UpdateUserRequest

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—
`update_mask`	`updateMask`	`google.protobuf.FieldMask`	singular	comma-joined field paths, e.g. `"name,status"`.

Response — tiyi.v1.UpdateUserResponse

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—

UserService.DeleteUser

Procedure POST /tiyi.v1.UserService/DeleteUser
Kind unary
Auth (user:delete)

Request — tiyi.v1.DeleteUserRequest

Field	JSON key	Type	Cardinality	Description
`id`	`id`	`string`	singular	—

Response — tiyi.v1.DeleteUserResponse

Field	JSON key	Type	Cardinality	Description
`result`	`result`	`MutationResult`	singular	—

UserService.AssignRoles

Procedure POST /tiyi.v1.UserService/AssignRoles
Kind unary
Auth (user:write)

Request — tiyi.v1.AssignRolesRequest

Field	JSON key	Type	Cardinality	Description
`user_id`	`userId`	`string`	singular	—
`role_ids`	`roleIds`	`string`	repeated	—

Response — tiyi.v1.AssignRolesResponse

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—

UserService.ResetPassword

Procedure POST /tiyi.v1.UserService/ResetPassword
Kind unary
Auth (user:write)

Request — tiyi.v1.ResetPasswordRequest

Field	JSON key	Type	Cardinality	Description
`user_id`	`userId`	`string`	singular	—
`password`	`password`	`string`	singular	—

Response — tiyi.v1.ResetPasswordResponse

Field	JSON key	Type	Cardinality	Description
`changed`	`changed`	`bool`	singular	—

UserService.LockUser

Procedure POST /tiyi.v1.UserService/LockUser
Kind unary
Auth (user:write)

Request — tiyi.v1.LockUserRequest

Field	JSON key	Type	Cardinality	Description
`user_id`	`userId`	`string`	singular	—

Response — tiyi.v1.LockUserResponse

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—

UserService.UnlockUser

Procedure POST /tiyi.v1.UserService/UnlockUser
Kind unary
Auth (user:write)

Request — tiyi.v1.UnlockUserRequest

Field	JSON key	Type	Cardinality	Description
`user_id`	`userId`	`string`	singular	—

Response — tiyi.v1.UnlockUserResponse

Field	JSON key	Type	Cardinality	Description
`user`	`user`	`User`	singular	—

UserService.ResetUserMFA

Procedure POST /tiyi.v1.UserService/ResetUserMFA
Kind unary
Auth (user:write)

Request — tiyi.v1.ResetUserMFARequest

Field	JSON key	Type	Cardinality	Description
`user_id`	`userId`	`string`	singular	—

Response — tiyi.v1.ResetUserMFAResponse

Field	JSON key	Type	Cardinality	Description
`mfa_reset`	`mfaReset`	`bool`	singular	—

RoleService.ListRoles

Procedure POST /tiyi.v1.RoleService/ListRoles
Kind unary
Auth (role:read)

Request — tiyi.v1.ListRolesRequest

Field	JSON key	Type	Cardinality	Description
`page`	`page`	`PageRequest`	singular	—
`query`	`query`	`string`	singular	—

Response — tiyi.v1.ListRolesResponse

Field	JSON key	Type	Cardinality	Description
`items`	`items`	`Role`	repeated	—
`page`	`page`	`PageResponse`	singular	—

RoleService.GetRole

Procedure POST /tiyi.v1.RoleService/GetRole
Kind unary
Auth (role:read)

Request — tiyi.v1.GetRoleRequest

Field	JSON key	Type	Cardinality	Description
`id`	`id`	`string`	singular	—

Response — tiyi.v1.GetRoleResponse

Field	JSON key	Type	Cardinality	Description
`role`	`role`	`Role`	singular	—

RoleService.CreateRole

Procedure POST /tiyi.v1.RoleService/CreateRole
Kind unary
Auth (role:write)

Request — tiyi.v1.CreateRoleRequest

Field	JSON key	Type	Cardinality	Description
`role`	`role`	`Role`	singular	—

Response — tiyi.v1.CreateRoleResponse

Field	JSON key	Type	Cardinality	Description
`role`	`role`	`Role`	singular	—

RoleService.UpdateRole

Procedure POST /tiyi.v1.RoleService/UpdateRole
Kind unary
Auth (role:write)

Request — tiyi.v1.UpdateRoleRequest

Field	JSON key	Type	Cardinality	Description
`role`	`role`	`Role`	singular	—
`update_mask`	`updateMask`	`google.protobuf.FieldMask`	singular	comma-joined field paths, e.g. `"name,status"`.

Response — tiyi.v1.UpdateRoleResponse

Field	JSON key	Type	Cardinality	Description
`role`	`role`	`Role`	singular	—

RoleService.DeleteRole

Procedure POST /tiyi.v1.RoleService/DeleteRole
Kind unary
Auth (role:delete)

Request — tiyi.v1.DeleteRoleRequest

Field	JSON key	Type	Cardinality	Description
`id`	`id`	`string`	singular	—

Response — tiyi.v1.DeleteRoleResponse

Field	JSON key	Type	Cardinality	Description
`result`	`result`	`MutationResult`	singular	—

RoleService.ListPermissions

Procedure POST /tiyi.v1.RoleService/ListPermissions
Kind unary
Auth (role:read)

Request — tiyi.v1.ListPermissionsRequest

No fields — send {}.

Response — tiyi.v1.ListPermissionsResponse

Field	JSON key	Type	Cardinality	Description
`permissions`	`permissions`	`Permission`	repeated	—

Messages

Permission

Field	JSON key	Type	Cardinality	Description
`code`	`code`	`string`	singular	—
`description`	`description`	`string`	singular	—

Role

Field	JSON key	Type	Cardinality	Description
`id`	`id`	`string`	singular	—
`tenant_id`	`tenantId`	`string`	singular	—
`name`	`name`	`string`	singular	—
`description`	`description`	`string`	singular	—
`builtin`	`builtin`	`bool`	singular	—
`permissions`	`permissions`	`string`	repeated	—
`created_at`	`createdAt`	`google.protobuf.Timestamp`	singular	RFC 3339 string, e.g. `2026-07-26T09:00:00Z`.
`updated_at`	`updatedAt`	`google.protobuf.Timestamp`	singular	RFC 3339 string, e.g. `2026-07-26T09:00:00Z`.
`member_count`	`memberCount`	`int64`	singular	JSON string (64-bit ints are quoted).

User

Field	JSON key	Type	Cardinality	Description
`id`	`id`	`string`	singular	—
`tenant_id`	`tenantId`	`string`	singular	—
`username`	`username`	`string`	singular	—
`email`	`email`	`string`	singular	—
`display_name`	`displayName`	`string`	singular	—
`roles`	`roles`	`Role`	repeated	—
`locked`	`locked`	`bool`	singular	—
`last_login_at`	`lastLoginAt`	`google.protobuf.Timestamp`	singular	RFC 3339 string, e.g. `2026-07-26T09:00:00Z`.
`created_at`	`createdAt`	`google.protobuf.Timestamp`	singular	RFC 3339 string, e.g. `2026-07-26T09:00:00Z`.
`updated_at`	`updatedAt`	`google.protobuf.Timestamp`	singular	RFC 3339 string, e.g. `2026-07-26T09:00:00Z`.
`deleted_at`	`deletedAt`	`google.protobuf.Timestamp`	singular	RFC 3339 string, e.g. `2026-07-26T09:00:00Z`.
`totp_enabled`	`totpEnabled`	`bool`	singular	—
`external_providers`	`externalProviders`	`string`	repeated	—