Protocol Documentation

Table of Contents

auth.proto

Top

LoginRequest

Request to initiate the login process

FieldTypeLabelDescription
redirect_url string

URL where the user should be redirected after successful authentication

LoginResponse

Response containing the authentication URL

FieldTypeLabelDescription
auth_url string

URL where the user should be directed to perform authentication

LogoutRequest

Request to initiate the logout process

FieldTypeLabelDescription
return_url string

URL where the user should be redirected after successful logout

LogoutResponse

Response containing the logout URL

FieldTypeLabelDescription
logout_url string

URL where the user should be directed to complete the logout process

VerifyRequest

Request to verify the authentication code

FieldTypeLabelDescription
code string

Authentication code received from the identity provider

VerifyResponse

Response containing authentication tokens and user information

FieldTypeLabelDescription
access_token string

Token used for accessing protected resources

id_token string

Token containing user identity information

profile string

JSON string containing user profile information

VerifyTokenRequest

Request to verify the validity of an authentication token

FieldTypeLabelDescription
token string

JWT token to be verified

VerifyTokenResponse

Response containing token verification results

FieldTypeLabelDescription
is_valid bool

Indicates if the token is valid and not expired

user_id string

Identifier of the user associated with the token

claims VerifyTokenResponse.ClaimsEntry repeated

Additional token claims containing user information and permissions

VerifyTokenResponse.ClaimsEntry

FieldTypeLabelDescription
key string

value string

AuthService

Authentication service for managing user sessions and verification

Method NameRequest TypeResponse TypeDescription
Login LoginRequest LoginResponse

Handle the login process for the user
Verify VerifyRequest VerifyResponse

Verify the validity of an authentication request
Logout LogoutRequest LogoutResponse

Handle the logout process for the user
VerifyToken VerifyTokenRequest VerifyTokenResponse

Verify the validity of an authentication token

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)