Documentation
¶
Index ¶
- Variables
- type LoginRequest
- func (*LoginRequest) Descriptor() ([]byte, []int)deprecated
- func (x *LoginRequest) GetEmail() string
- func (x *LoginRequest) GetMfaCode() uint32
- func (x *LoginRequest) GetPassword() string
- func (*LoginRequest) ProtoMessage()
- func (x *LoginRequest) ProtoReflect() protoreflect.Message
- func (x *LoginRequest) Reset()
- func (x *LoginRequest) String() string
- type TokenIntrospectRequest
- func (*TokenIntrospectRequest) Descriptor() ([]byte, []int)deprecated
- func (x *TokenIntrospectRequest) GetToken() string
- func (x *TokenIntrospectRequest) GetTokenTypeHint() string
- func (*TokenIntrospectRequest) ProtoMessage()
- func (x *TokenIntrospectRequest) ProtoReflect() protoreflect.Message
- func (x *TokenIntrospectRequest) Reset()
- func (x *TokenIntrospectRequest) String() string
- type TokenRequest
- func (*TokenRequest) Descriptor() ([]byte, []int)deprecated
- func (x *TokenRequest) GetAudience() string
- func (x *TokenRequest) GetClientId() string
- func (x *TokenRequest) GetClientSecret() string
- func (x *TokenRequest) GetCode() string
- func (x *TokenRequest) GetGrantType() string
- func (x *TokenRequest) GetRedirectUri() string
- func (*TokenRequest) ProtoMessage()
- func (x *TokenRequest) ProtoReflect() protoreflect.Message
- func (x *TokenRequest) Reset()
- func (x *TokenRequest) String() string
- type UserRegisterRequest
- func (*UserRegisterRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UserRegisterRequest) GetEmail() string
- func (x *UserRegisterRequest) GetPassword() string
- func (x *UserRegisterRequest) GetPhoneNumber() string
- func (x *UserRegisterRequest) GetUsername() string
- func (*UserRegisterRequest) ProtoMessage()
- func (x *UserRegisterRequest) ProtoReflect() protoreflect.Message
- func (x *UserRegisterRequest) Reset()
- func (x *UserRegisterRequest) String() string
Constants ¶
This section is empty.
Variables ¶
var File_proto_request_introspect_proto protoreflect.FileDescriptor
var File_proto_request_login_proto protoreflect.FileDescriptor
var File_proto_request_register_proto protoreflect.FileDescriptor
var File_proto_request_token_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type LoginRequest ¶
type LoginRequest struct {
// email - The primary email address for the user. Must be unique
Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty" bson:"email" query:"email"` // @gotags: bson:"email" query:"email"
// password - The plain text password for the user. Will be hashed on the server-side using ArgonV2ID
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty" bson:"password" query:"password"` // @gotags: bson:"password" query:"password"
// mfaCode - The user's multifactor authentication code generated on there device
MfaCode uint32 `protobuf:"varint,3,opt,name=mfa_code,json=mfaCode,proto3" json:"mfa_code,omitempty" bson:"mfa_code" query:"mfa_code"` // @gotags: bson:"mfa_code" query:"mfa_code"
// contains filtered or unexported fields
}
func (*LoginRequest) Descriptor
deprecated
func (*LoginRequest) Descriptor() ([]byte, []int)
Deprecated: Use LoginRequest.ProtoReflect.Descriptor instead.
func (*LoginRequest) GetEmail ¶
func (x *LoginRequest) GetEmail() string
func (*LoginRequest) GetMfaCode ¶
func (x *LoginRequest) GetMfaCode() uint32
func (*LoginRequest) GetPassword ¶
func (x *LoginRequest) GetPassword() string
func (*LoginRequest) ProtoMessage ¶
func (*LoginRequest) ProtoMessage()
func (*LoginRequest) ProtoReflect ¶
func (x *LoginRequest) ProtoReflect() protoreflect.Message
func (*LoginRequest) Reset ¶
func (x *LoginRequest) Reset()
func (*LoginRequest) String ¶
func (x *LoginRequest) String() string
type TokenIntrospectRequest ¶ added in v1.3.3
type TokenIntrospectRequest struct {
// token - The token that the user wishes to introspect
Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty" bson:"token"` // @gotags: bson:"token"
// token_type_hint - A hint that assists the server in what token is being passed. Can be: access_token, refresh_token
TokenTypeHint string `protobuf:"bytes,3,opt,name=token_type_hint,json=tokenTypeHint,proto3" json:"token_type_hint,omitempty" bson:"token_type_hint"` // @gotags: bson:"token_type_hint"
// contains filtered or unexported fields
}
TokenIntrospectRequest - Represents an end-user request to the /oauth/introspect endpoint
func (*TokenIntrospectRequest) Descriptor
deprecated
added in
v1.3.3
func (*TokenIntrospectRequest) Descriptor() ([]byte, []int)
Deprecated: Use TokenIntrospectRequest.ProtoReflect.Descriptor instead.
func (*TokenIntrospectRequest) GetToken ¶ added in v1.3.3
func (x *TokenIntrospectRequest) GetToken() string
func (*TokenIntrospectRequest) GetTokenTypeHint ¶ added in v1.3.3
func (x *TokenIntrospectRequest) GetTokenTypeHint() string
func (*TokenIntrospectRequest) ProtoMessage ¶ added in v1.3.3
func (*TokenIntrospectRequest) ProtoMessage()
func (*TokenIntrospectRequest) ProtoReflect ¶ added in v1.3.3
func (x *TokenIntrospectRequest) ProtoReflect() protoreflect.Message
func (*TokenIntrospectRequest) Reset ¶ added in v1.3.3
func (x *TokenIntrospectRequest) Reset()
func (*TokenIntrospectRequest) String ¶ added in v1.3.3
func (x *TokenIntrospectRequest) String() string
type TokenRequest ¶
type TokenRequest struct {
// grant_type - Describes the type of OAuth grant flow you are using
GrantType string `protobuf:"bytes,1,opt,name=grant_type,json=grantType,proto3" json:"grant_type,omitempty" bson:"grant_type" query:"grant_type"` // @gotags: bson:"grant_type" query:"grant_type"
// client_id - The client id of the application. Can be null in some cases
ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty" bson:"client_id" query:"client_id"` // @gotags: bson:"client_id" query:"client_id"
// client_secret - The client secret of the application. Can be null in some cases
ClientSecret string `` // @gotags: bson:"client_secret" query:"client_secret"
/* 140-byte string literal not displayed */
// audience - The audience for the API you are requesting a token for
Audience string `protobuf:"bytes,4,opt,name=audience,proto3" json:"audience,omitempty" bson:"audience" query:"audience"` // @gotags: bson:"audience" query:"audience"
// code - The code used in Authorization Code flow
Code string `protobuf:"bytes,5,opt,name=code,proto3" json:"code,omitempty" bson:"code" query:"code"` // @gotags: bson:"code" query:"code"
// redirect_uri - The redirect URI used in Authorization code flow
RedirectUri string `` // @gotags: bson:"redirect_uri" query:"redirect_uri"
/* 135-byte string literal not displayed */
// contains filtered or unexported fields
}
TokenRequest - Universal token request model for use in: Client credentials flow, authorization code flow, and password grant flow
func (*TokenRequest) Descriptor
deprecated
func (*TokenRequest) Descriptor() ([]byte, []int)
Deprecated: Use TokenRequest.ProtoReflect.Descriptor instead.
func (*TokenRequest) GetAudience ¶
func (x *TokenRequest) GetAudience() string
func (*TokenRequest) GetClientId ¶
func (x *TokenRequest) GetClientId() string
func (*TokenRequest) GetClientSecret ¶
func (x *TokenRequest) GetClientSecret() string
func (*TokenRequest) GetCode ¶
func (x *TokenRequest) GetCode() string
func (*TokenRequest) GetGrantType ¶
func (x *TokenRequest) GetGrantType() string
func (*TokenRequest) GetRedirectUri ¶
func (x *TokenRequest) GetRedirectUri() string
func (*TokenRequest) ProtoMessage ¶
func (*TokenRequest) ProtoMessage()
func (*TokenRequest) ProtoReflect ¶
func (x *TokenRequest) ProtoReflect() protoreflect.Message
func (*TokenRequest) Reset ¶
func (x *TokenRequest) Reset()
func (*TokenRequest) String ¶
func (x *TokenRequest) String() string
type UserRegisterRequest ¶
type UserRegisterRequest struct {
// email - The primary email address for the user. Must be unique
Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty" bson:"email" query:"email"` // @gotags: bson:"email" query:"email"
// username - The username of the user. Does not need to be unique as primary lookup for the user is done via userId
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty" bson:"username" query:"username"` // @gotags: bson:"username" query:"username"
// password - The plain text password for the user. Will be hashed on the server-side using ArgonV2ID
Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty" bson:"password" query:"password"` // @gotags: bson:"password" query:"password"
// phone_number - The users phone number in the following format +1800-555-555
PhoneNumber string `` // @gotags: bson:"phone_number" query:"phone_number"
/* 135-byte string literal not displayed */
// contains filtered or unexported fields
}
UserRegisterRequest - Provides a way for user's to register there accounts on a service. Any values not provided in this request must be modified after user-registration
func (*UserRegisterRequest) Descriptor
deprecated
func (*UserRegisterRequest) Descriptor() ([]byte, []int)
Deprecated: Use UserRegisterRequest.ProtoReflect.Descriptor instead.
func (*UserRegisterRequest) GetEmail ¶
func (x *UserRegisterRequest) GetEmail() string
func (*UserRegisterRequest) GetPassword ¶
func (x *UserRegisterRequest) GetPassword() string
func (*UserRegisterRequest) GetPhoneNumber ¶
func (x *UserRegisterRequest) GetPhoneNumber() string
func (*UserRegisterRequest) GetUsername ¶
func (x *UserRegisterRequest) GetUsername() string
func (*UserRegisterRequest) ProtoMessage ¶
func (*UserRegisterRequest) ProtoMessage()
func (*UserRegisterRequest) ProtoReflect ¶
func (x *UserRegisterRequest) ProtoReflect() protoreflect.Message
func (*UserRegisterRequest) Reset ¶
func (x *UserRegisterRequest) Reset()
func (*UserRegisterRequest) String ¶
func (x *UserRegisterRequest) String() string