auth

Documentation

Index

• func SetService(svc Service)
• func Signup(ctx context.ServiceContext, client *clients.GQLClient, options *SignupOptions) error
• func UpdatePassword(ctx context.ServiceContext, client *clients.HTTPClient, ...) error
• type DecryptKeysFromSessionOptions
• type DefaultService
  • func (*DefaultService) DecryptKeysFromSession(ctx context.ServiceContext, client *clients.GQLClient, ...) (*keyCommons.Payload, error)
  • func (*DefaultService) GenerateTOTPQR(ctx context.ServiceContext, client *clients.NhostClient) (*GenerateQRResponse, error)
  • func (*DefaultService) RefreshToken(ctx context.ServiceContext, client *clients.NhostClient, ...) (*RefreshTokenResponse, error)
  • func (*DefaultService) SigninWithMFA(ctx context.ServiceContext, client *clients.NhostClient, ...) (*SigninResponse, error)
  • func (*DefaultService) SigninWithPAT(ctx context.ServiceContext, client *clients.NhostClient, ...) (*SigninResponse, error)
  • func (*DefaultService) SigninWithPassword(ctx context.ServiceContext, client *clients.NhostClient, ...) (*SigninResponse, error)
  • func (*DefaultService) ToggleMFA(ctx context.ServiceContext, client *clients.NhostClient, ...) error
• type GenerateQRResponse
• type MFAType
• type NhostSession
• type NhostSigninResponse
• type RefreshTokenOptions
• type RefreshTokenResponse
• type Service
  • func GetService() Service
• type SigninResponse
• type SigninWithMFAOptions
  • func (o *SigninWithMFAOptions) JSONMarshal() ([]byte, error)
• type SigninWithPATOptions
• type SigninWithPasswordOptions
• type SignupOptions
• type ToggleMFAOptions
  • func (o *ToggleMFAOptions) JSONMarshal() ([]byte, error)
• type UpdatePasswordOptions

Functions

func SetService

func SetService(svc Service)

func Signup

func Signup(ctx context.ServiceContext, client *clients.GQLClient, options *SignupOptions) error

func UpdatePassword

func UpdatePassword(ctx context.ServiceContext, client *clients.HTTPClient, options *UpdatePasswordOptions) error

Types

type DecryptKeysFromSessionOptions

type DecryptKeysFromSessionOptions struct {
	Password string `json:"password"`
	Session  map[string]interface{}
}

type DefaultService

type DefaultService struct{}

func (*DefaultService) DecryptKeysFromSession

func (*DefaultService) DecryptKeysFromSession(ctx context.ServiceContext, client *clients.GQLClient, options *DecryptKeysFromSessionOptions) (*keyCommons.Payload, error)

func (*DefaultService) GenerateTOTPQR

func (*DefaultService) GenerateTOTPQR(ctx context.ServiceContext, client *clients.NhostClient) (*GenerateQRResponse, error)

func (*DefaultService) RefreshToken

func (*DefaultService) RefreshToken(ctx context.ServiceContext, client *clients.NhostClient, options *RefreshTokenOptions) (*RefreshTokenResponse, error)

func (*DefaultService) SigninWithMFA

func (*DefaultService) SigninWithMFA(ctx context.ServiceContext, client *clients.NhostClient, options *SigninWithMFAOptions) (*SigninResponse, error)

func (*DefaultService) SigninWithPAT

func (*DefaultService) SigninWithPAT(ctx context.ServiceContext, client *clients.NhostClient, options *SigninWithPATOptions) (*SigninResponse, error)

func (*DefaultService) SigninWithPassword

func (*DefaultService) SigninWithPassword(ctx context.ServiceContext, client *clients.NhostClient, options *SigninWithPasswordOptions) (*SigninResponse, error)

func (*DefaultService) ToggleMFA

func (*DefaultService) ToggleMFA(ctx context.ServiceContext, client *clients.NhostClient, options *ToggleMFAOptions) error

Remember: Passing a nil value to the "ActiveMFAType" option will deactivate MFA.

type GenerateQRResponse

type GenerateQRResponse struct {
	Secret string `json:"secret"`
	Image  string `json:"image"`
}

type MFAType

type MFAType string

const TOTP MFAType = "totp"

type NhostSession

type NhostSession struct {
	AccessToken  string `json:"accessToken"`
	RefreshToken string `json:"refreshToken"`
}

type NhostSigninResponse

type NhostSigninResponse struct {
	MFA     map[string]interface{} `json:"mfa"`
	Session map[string]interface{} `json:"session"`
}

type RefreshTokenOptions

type RefreshTokenOptions struct {
	RefreshToken string `json:"refreshToken"`
}

type RefreshTokenResponse

type RefreshTokenResponse struct {
	AccessToken  string     `json:"accessToken"`
	RefreshToken string     `json:"refreshToken"`
	User         users.User `json:"user"`
}

type Service

type Service interface {
	ToggleMFA(context.ServiceContext, *clients.NhostClient, *ToggleMFAOptions) error
	GenerateTOTPQR(context.ServiceContext, *clients.NhostClient) (*GenerateQRResponse, error)
	SigninWithMFA(context.ServiceContext, *clients.NhostClient, *SigninWithMFAOptions) (*SigninResponse, error)
	SigninWithPassword(context.ServiceContext, *clients.NhostClient, *SigninWithPasswordOptions) (*SigninResponse, error)
	SigninWithPAT(context.ServiceContext, *clients.NhostClient, *SigninWithPATOptions) (*SigninResponse, error)
	RefreshToken(context.ServiceContext, *clients.NhostClient, *RefreshTokenOptions) (*RefreshTokenResponse, error)
	DecryptKeysFromSession(context.ServiceContext, *clients.GQLClient, *DecryptKeysFromSessionOptions) (*keyCommons.Payload, error)
}

func GetService

func GetService() Service

type SigninResponse

type SigninResponse struct {
	MFA     map[string]interface{} `json:"mfa"`
	Session map[string]interface{} `json:"session"`
	Keys    map[string]string      `json:"keys"`
}

type SigninWithMFAOptions

type SigninWithMFAOptions struct {
	OTP    string `json:"otp"`
	Ticket string `json:"ticket"`
}

func (*SigninWithMFAOptions) JSONMarshal

func (o *SigninWithMFAOptions) JSONMarshal() ([]byte, error)

Custom marshaller for the SigninWithMFAOptions.

type SigninWithPATOptions

type SigninWithPATOptions struct {
	PAT string `json:"personalAccessToken"`
}

type SigninWithPasswordOptions

type SigninWithPasswordOptions struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type SignupOptions

type SignupOptions struct {
	Email    string `json:"email"`
	Password string `json:"password"`
	Name     string `json:"name"`
}

type ToggleMFAOptions

type ToggleMFAOptions struct {
	Code string `json:"code"`

	//	The value of "null" will deactivate MFA.
	ActiveMFAType MFAType `json:"activeMfaType"`
}

func (*ToggleMFAOptions) JSONMarshal

func (o *ToggleMFAOptions) JSONMarshal() ([]byte, error)

Custom marshaller for the ToggleMFAOptions.

type UpdatePasswordOptions

type UpdatePasswordOptions struct {
	NewPassword string `json:"newPassword,omitempty"`
	OldPassword string `json:"oldPassword,omitempty"`
}