package api.v1.authentication

Get desktop application:
View/edit binary Protocol Buffers messages

The service to manage public endpoints in Users

rpc Login (LoginRequest, LoginResponse)
service.proto:12
Login authenticats a user and returns a access/refresh token
message LoginRequest
service.proto:79
Login request with either user identifier & email or client credentials.
- oneof method
  - UserPassword user_password = 1
    User identifier & password.
  - ClientCredentials client_credentials = 3
    Client credentials from service account.
message LoginResponse
service.proto:89
Login response with tokens and user information.
- optional Token token = 1
  The access token and refresh token.
- string user_id = 2
  ID of the user.
- optional model.UserInfo user_info = 3
  User information.
rpc Logout (LogoutRequest, LogoutResponse)
service.proto:14
Logout validates the access token and blocks it afterwards
message LogoutRequest
service.proto:99
Empty logout request. The user ID etc. is taken from the token.
(message has no fields)
message LogoutResponse
service.proto:102
Empty response to the logout request.
(message has no fields)
rpc Get (GetRequest, GetResponse)
service.proto:16
Get the logged in user
message GetRequest
service.proto:106
Get request to get the logged in user. The user ID etc. is taken from the token.
(message has no fields)
message GetResponse
service.proto:109
Response with user information to the get request.
- optional model.UserInfo user_info = 1
  Information about the user.
- string user_id = 2
  ID of the user
rpc Register (RegisterRequest, RegisterResponse)
service.proto:18
Register creates a new user
message RegisterRequest
service.proto:118
Register request for users to self-register. This is only possible with the register bool set in users settings.
- oneof method
  - UserPassword user_password = 1
    User identifier & password for the new user.
message RegisterResponse
service.proto:126
Register response with tokens and user information.
- optional Token token = 1
  Access and refresh token for the new logged in user.
- string user_id = 2
  User ID of the new user.
- optional model.UserInfo user_info = 3
  Information about the new user.
rpc SendPasswordReset (SendPasswordResetRequest, SendPasswordResetResponse)
service.proto:20
Send reset password email to the user
message SendPasswordResetRequest
service.proto:137
Request to send a reset password email to the user. This is only possible if an email provider is configured, and the user has an email.
- optional model.UserIdentifier identifier = 1
  User identifier of the user.
message SendPasswordResetResponse
service.proto:143
Empty response to the send password reset request
- string token = 1
  JWT token to reset the password.
rpc ResetPassword (ResetPasswordRequest, ResetPasswordResponse)
service.proto:23
Reset password of the user
message ResetPasswordRequest
service.proto:150
Request to reset the password of a user with a verification code sent to the email.
- string code = 1
  The 6 digit verification code
- string new_password = 2
  The new password
- optional model.UserIdentifier identifier = 3
  Identifier of the user
- string token = 4
  JWT token to reset the password.
message ResetPasswordResponse
service.proto:162
Empty response to the reset password request
(message has no fields)
rpc Delete (DeleteRequest, DeleteResponse)
service.proto:25
Delete logged in user
message DeleteRequest
service.proto:166
Request to delete the logged in user. The user ID etc. is taken from the token.
(message has no fields)
message DeleteResponse
service.proto:169
Empty response to the delete request.
(message has no fields)
rpc RefreshToken (RefreshTokenRequest, RefreshTokenResponse)
service.proto:27
Refresh logged in token pair
message RefreshTokenRequest
service.proto:172
Request to refresh the access and refresh token of the logged in user.
- string refresh_token = 1
  The access token of the user Refresh token matching the access token.
message RefreshTokenResponse
service.proto:179
Response with new access and refresh token.
- optional Token token = 1
  New refresh and access tokens
rpc GetAuthConfig (GetAuthConfigRequest, GetAuthConfigResponse)
service.proto:29
Get auth config for how available login methods
message GetAuthConfigRequest
service.proto:186
Empty Request to get the auth config containing the available login mechanisms and if self-registering is enabled.
(message has no fields)
message GetAuthConfigResponse
service.proto:190
Response with the auth config containing the available login mechanisms and if self-registering is enabled.
- string name = 1
  The name of the project
- string logo_url = 2
  The logo of the project
- bool validate_password = 3
  If to validate password
- repeated model.LoginType login_types = 4
  Array of supported login methods.
- bool allows_register = 7
  True if new users can sign up.
- repeated SSOOption sso_options = 8
  SSO login options
rpc VerifyEmail (VerifyEmailRequest, VerifyEmailResponse)
service.proto:31
Verify email
message VerifyEmailRequest
service.proto:56
Request to verify the email of a user with a verification code sent to the email.
- string code = 1
  The verification code.
- string email = 2
  The email of the user.
- string token = 3
  JWT token to verify the email.
message VerifyEmailResponse
service.proto:66
Empty response to the Verify Email Request.
(message has no fields)
rpc VerifyPhoneNumber (VerifyPhoneNumberRequest, VerifyPhoneNumberResponse)
service.proto:33
Verify phone number
message VerifyPhoneNumberRequest
service.proto:70
Request to verify the phone number of a user with a verification code sent to the phone number.
- string code = 1
- string phone_number = 2
message VerifyPhoneNumberResponse
service.proto:76
Empty response to the Verify Phone Number Request.
(message has no fields)
rpc SendVerificationEmail (SendVerificationEmailRequest, SendVerificationEmailResponse)
service.proto:35
message SendVerificationEmailRequest
service.proto:43
Request to send an email containing the code for the email verification flow. This is an upsert, and will invalidate the current verification-code if it exists. Only possible if an email-provider is configured, and the user has en email.
- optional model.UserIdentifier identifier = 1
  User identifier of the user.
message SendVerificationEmailResponse
service.proto:49
Empty response for sending a verification email
- string token = 1
  JWT token to verify the email.

string client_id = 1
ID of the service account
string client_secret = 2
secret of the service account

Represents an SSO provided ID of a user

SSOType type = 1
What type of SSO this ID is from
string provider_id = 2
The ID of the SSO provider
string sso_id = 3
The ID provided by SSO
string user_id = 4
The internal user ID

A login option for using SSO. This might be merged into GetAuthConfigResponse.login_types, but is introduced as a separate field, to maintain backwards compatibility.

Used in: GetAuthConfigResponse

SSOType type = 1
Type of SSO. Currently only OIDC is supported.
string provider_id = 2
ID of the SSO provider as given in the platform configuration.
string name = 3
Name of SSO provider. This is an optional human readable version of the provider ID.
string icon = 4
URL of the underlying issuer. This can be used in the frontend for showing specific items for certain known issuers.

The type of SSO. Currently only OIDC is supported.

Used in: SSOID, SSOOption

SSO_TYPE_UNSPECIFIED = 0
SSO_TYPE_OIDC = 1

Used in: LoginResponse, RefreshTokenResponse, RegisterResponse

string access_token = 1
Access token
string refresh_token = 2
Refresh token

Used in: LoginRequest, RegisterRequest

optional model.UserIdentifier identifier = 1
Identifier of user. This can be username, email etc.
string password = 2
Password of the user

package api.v1.authentication

service Service

rpc Login (LoginRequest, LoginResponse)

message LoginRequest

oneof method

UserPassword user_password = 1

ClientCredentials client_credentials = 3

message LoginResponse

optional Token token = 1

string user_id = 2

optional model.UserInfo user_info = 3

rpc Logout (LogoutRequest, LogoutResponse)

message LogoutRequest

message LogoutResponse

rpc Get (GetRequest, GetResponse)

message GetRequest

message GetResponse

optional model.UserInfo user_info = 1

string user_id = 2

rpc Register (RegisterRequest, RegisterResponse)

message RegisterRequest

oneof method

UserPassword user_password = 1

message RegisterResponse

optional Token token = 1

string user_id = 2

optional model.UserInfo user_info = 3

rpc SendPasswordReset (SendPasswordResetRequest, SendPasswordResetResponse)

message SendPasswordResetRequest

optional model.UserIdentifier identifier = 1

message SendPasswordResetResponse

string token = 1

rpc ResetPassword (ResetPasswordRequest, ResetPasswordResponse)

message ResetPasswordRequest

string code = 1

string new_password = 2

optional model.UserIdentifier identifier = 3

string token = 4

message ResetPasswordResponse

rpc Delete (DeleteRequest, DeleteResponse)

message DeleteRequest

message DeleteResponse

rpc RefreshToken (RefreshTokenRequest, RefreshTokenResponse)

message RefreshTokenRequest

string refresh_token = 1

message RefreshTokenResponse

optional Token token = 1

rpc GetAuthConfig (GetAuthConfigRequest, GetAuthConfigResponse)

message GetAuthConfigRequest

message GetAuthConfigResponse

string name = 1

string logo_url = 2

bool validate_password = 3

repeated model.LoginType login_types = 4

bool allows_register = 7

repeated SSOOption sso_options = 8

rpc VerifyEmail (VerifyEmailRequest, VerifyEmailResponse)

message VerifyEmailRequest

string code = 1

string email = 2

string token = 3

message VerifyEmailResponse

rpc VerifyPhoneNumber (VerifyPhoneNumberRequest, VerifyPhoneNumberResponse)

message VerifyPhoneNumberRequest

string code = 1

string phone_number = 2

message VerifyPhoneNumberResponse

rpc SendVerificationEmail (SendVerificationEmailRequest, SendVerificationEmailResponse)

message SendVerificationEmailRequest

optional model.UserIdentifier identifier = 1

message SendVerificationEmailResponse

string token = 1

message ClientCredentials

string client_id = 1

string client_secret = 2

message SSOID

SSOType type = 1

string provider_id = 2

string sso_id = 3

string user_id = 4