auth

API Reference: v1/auth.proto

Table of Contents

Services

AuthService

AuthService provides authentication functionality

Token

rpc Token(TokenRequest) TokenResponse

Token generates new access and refresh tokens using credentials

RefreshToken

rpc RefreshToken(RefreshTokenRequest) TokenResponse

RefreshToken generates new access and refresh tokens using existing refresh token

Messages

PasswordCredential

PasswordCredential contains username and password credentials

Field Type Description
username string none
password string none

RefreshTokenRequest

RefreshTokenRequest contains refresh token for generating new tokens

Field Type Description
refresh_token string none

TokenRequest

TokenRequest contains credentials for token generation Currently only password credential is fully implemented

Field Type Description
oneof credential.password_credential PasswordCredential Uncomment when implementing API key authentication ApiKeyCredential api_key_credential = 2; Additional credential types can be added here

TokenResponse

TokenResponse contains generated access and refresh tokens

Field Type Description
access_token string none
refresh_token string none

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type

double
double double float

float
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

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

uint32
Uses variable-length encoding. uint32 int int/long

uint64
Uses variable-length encoding. uint64 long int/long

sint32
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int

sint64
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long

fixed32
Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int

fixed64
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long

sfixed32
Always four bytes. int32 int int

sfixed64
Always eight bytes. int64 long int/long

bool
bool boolean boolean

string
A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode

bytes
May contain any arbitrary sequence of bytes. string ByteString str