Skip to main content

auth.proto

path mgmt/v1alpha1/auth.proto

package mgmt.v1alpha1


Messages

AccessToken

A decoded representation of an Access token from the backing auth server

NameTypeDescription
access_tokenstringThe access token that will be provided in subsequent requests to provide authenticated access to the Api
refresh_tokenoptional stringToken that can be used to retrieve a refreshed access token. Will not be provided if the offline_access scope is not provided in the initial login flow.
expires_inint64Relative time in seconds that the access token will expire. Combine with the current time to get the expires_at time.
scopestringThe scopes that the access token have
id_tokenoptional stringThe identity token of the authenticated user
token_typestringThe token type. For JWTs, this will be `Bearer`

GetAuthStatusRequest

NameTypeDescription

GetAuthStatusResponse

NameTypeDescription
is_enabledboolWhether or not the server has authentication enabled. This tells the client if it is expected to send access tokens.

GetAuthorizeUrlRequest

NameTypeDescription
statestringThe state that's generated by the client that is passed along to prevent tampering
redirect_uristringThe redirect uri that the client will be redirected back to during the auth request
scopestringThe scopes the client is requesting as a part of the oauth login request

GetAuthorizeUrlResponse

NameTypeDescription
urlstringThe generated url that is the client will be redirected to during the Oauth flow

GetCliIssuerRequest

NameTypeDescription

GetCliIssuerResponse

NameTypeDescription
issuer_urlstringThe backing authentication issuer url
audiencestringThe audience that will be used in the access token. This corresponds to the "aud" claim

LoginCliRequest

NameTypeDescription
codestringThe oauth code
redirect_uristringThe oauth redirect uri that the client uses during the oauth request

LoginCliResponse

NameTypeDescription
access_tokenAccessTokenThe access token that is returned on successful login

RefreshCliRequest

NameTypeDescription
refresh_tokenstringThe token used to retrieve a new access token.

RefreshCliResponse

NameTypeDescription
access_tokenAccessTokenThe access token that is returned on successful refresh

Services

AuthService

Service that handles generic Authentication for Neosync Today this is mostly used by the CLI to receive authentication information

LoginCli

MethodLoginCli
RequestLoginCliRequest
ResponseLoginCliResponse
DescriptionUsed by the CLI to login to Neosync with OAuth.

RefreshCli

MethodRefreshCli
RequestRefreshCliRequest
ResponseRefreshCliResponse
DescriptionUsed by the CLI to refresh an expired Neosync accesss token. This should only be used if an access token was previously retrieved from the `LoginCli` or `RefreshCli` methods.

GetCliIssuer

MethodGetCliIssuer
RequestGetCliIssuerRequest
ResponseGetCliIssuerResponse
DescriptionUsed by the CLI to retrieve Auth Issuer information

GetAuthorizeUrl

MethodGetAuthorizeUrl
RequestGetAuthorizeUrlRequest
ResponseGetAuthorizeUrlResponse
DescriptionUsed by the CLI to retrieve an Authorize URL for use with OAuth login.

GetAuthStatus

MethodGetAuthStatus
RequestGetAuthStatusRequest
ResponseGetAuthStatusResponse
DescriptionReturns the auth status of the API server. Whether or not the backend has authentication enabled. This is used by clients to make decisions on whether or not they should send access tokens to the API.