Skip to main content

auth.proto

path server/v1/auth.proto

package tigrisdata.auth.v1


Messages

GetAccessTokenRequest

Requests the access token by specifying grant_type:refresh_token & refresh_token or grant_type:client_credentials & [client_id, client_secret]

NameTypeDescription
grant_typeGrantType
refresh_tokenstringcase: refresh_token: A valid refresh token
client_idstringcase: client_credentials: A valid credentials (client_id, client_secret, audience)
client_secretstring

GetAccessTokenResponse

GetAccessToken returns response containing access_token and optionally refresh_token

NameTypeDescription
access_tokenstringAn access token.
refresh_tokenstringRefresh token.
expires_inint32Access token expiration timeout in seconds

Enums

GrantType

NameNumberDescription
REFRESH_TOKEN0
CLIENT_CREDENTIALS1

Services

Auth

getAccessToken

MethodgetAccessToken
RequestGetAccessTokenRequest
ResponseGetAccessTokenResponse
DescriptionGets an access token. supports two grant_type: [refresh_token, client_credentials]