package api.v1.user
Get desktop application:
View/edit binary Protocol Buffers messages
service Service
service.proto:10The service to manage users in Users.
rpc Create (, )
service.proto:12Create a new user.
message
service.proto:41The request to create a user.
repeated initializers = 1
Initial fields to set.
string initial_group_id = 2
If set, the user will be added to this group upon creation.
message
service.proto:49The response of creating a user.
optional user = 1
The created user.
rpc Update (, )
service.proto:14Update a users profile and info.
message
service.proto:55The request of updating a user.
string user_id = 1
The user identifier of the user to update.
repeated updates = 2
The updates to apply to the user.
message
service.proto:63Empty update response.
(message has no fields)
rpc ListSessions (, )
service.proto:16Get the list of active sessions for the given user.
message
service.proto:78Request to list a users login sessions.
string user_id = 1
The user to retrieve sessions for.
optional pagination = 2
Pagination options.
message
service.proto:86The response of listing a users login sessions.
repeated sessions = 1
The retrieved sessions.
uint64 total = 2
The total number of sessions.
rpc Get (, )
service.proto:18Get a user by user-id.
message
service.proto:66Get request for retrieving a user.
string user_id = 1
The user identifier to fetch the user.
message
service.proto:72The response of getting a user.
optional user = 1
The retrieved user.
rpc GetByIdentifier (, )
service.proto:20Lookup a user by a unique identifier - email, username, phone number etc.
message
service.proto:29Request to get a user by an identifier.
optional identifier = 1
The identifier to lookup.
message
service.proto:35Response to get a user by an identifier.
optional user = 1
The user.
rpc List (, )
service.proto:23List users.
message
service.proto:103Request for listing users.
optional pagination = 1
Pagination options.
string search = 2
Search string.
message
service.proto:111Response for listing users.
repeated users = 1
The users returned.
uint64 total = 2
total number of users.
rpc Delete (, )
service.proto:25Delete a specific user.
message
service.proto:94Request for deleting a user.
string user_id = 1
The user identifier to fetch the user.
message
service.proto:100Empty response for deleting a user.
(message has no fields)
message
user.proto:108how a user is authenticated.
Used in:
oneof method
model.LoginType login_type = 1
Login type of the user.
message
user.proto:43User profile
Used in: ,
string first_name = 1
First name of the user.
string last_name = 2
Last name of the user.
message
user.proto:123A user's sessions.
Used in:
optional auth_method = 1
how the user is authenticated.
bool is_invalidated = 2
if the session is invalidated
optional created_at = 3
Timestamp when the session was created.
optional invalidated_at = 4
Timestamp when the session was invalidated.
optional expires_at = 5
Timestamp when the session expires.
optional renewed_at = 6
Timestamp when the session was renewed.
string country = 7
Country of the session.
int32 postal_code = 8
Postal code of the session.
message
user.proto:116Session entry
Used in:
string session_id = 1
Session ID of the session.
optional session = 2
Session of the session.
message
user.proto:74Update message to update a user.
Used in: ,
oneof field
field of the user to update./
string email = 1
Email of the user.
string username = 2
Username of the user.
string phone_number = 3
Deprecated: text is not supported - Phone number of the user.
string password = 4
Password of the user.
profile = 5
Profile of the user.
bool is_email_verified = 6
Whether the user's email is verified.
bool is_phone_verified = 7
Deprecated: text is not supported - Whether the user's phone number is verified.
reset_sessions = 8
Reset sessions of the user.
set_metadata = 9
Set metadata of the user.
string delete_metadata_key = 10
Delete metadata of the user.
hashed_password = 12
Hashed password of the user.
message
user.proto:77if sessions are reset, all sessions will be invalidated and a new session will be created.
Used in:
(message has no fields)
message
user.proto:51The user model.
Used in: , ,
string user_id = 1
User ID of the user.
optional user_info = 2
User info of the user.
optional profile = 3
Profile of the user.
optional updated_at = 4
Timestamp when the user was last updated.
optional register_info = 5
Register info of the user.
bool is_phone_verified = 6
Deprecated: text is not supported - Whether the user's phone number is verified.
bool is_email_verified = 7
Whether the user's email is verified.
optional new_sessions_since = 8
Timestamp when the user last created a new session.
map<string, bytes> metadata = 9
Metadata of the user.
message
user.proto:25short-lived verification code.
optional code = 1
Hashed verification code.
optional sent_at = 2
Timestamp when the verification code was sent.
optional expires_at = 3
Timestamp when the verification code expires.
int32 attempts = 4
Number of attempts to verify the code.
optional last_attempt = 5
Timestamp of the last attempt to verify the code.
VerificationType type = 6
Type of verification code.
string user_id = 7
User ID of the user who the code was sent to.
Type of verification code
Used in:
VERIFICATION_TYPE_UNSPECIFIED = 0
Default value
VERIFICATION_TYPE_EMAIL = 1
Email verification code.
VERIFICATION_TYPE_TEXT = 2
Deprecated: text is not supported - text verification code.
VERIFICATION_TYPE_RESET_PASSWORD = 3
reset password verification code.