Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

types

package

Go to main page

Versions in this module

v1

v1.3.2

Oct 9, 2024

Changes in this version

type AuthorizeRequest

+ RedirectTo string

v1.3.1

Oct 9, 2024

v1.3.0

Sep 8, 2024

Changes in this version

+ const VerificationTypeEmailChange

+ const VerificationTypeInvite

+ const VerificationTypeMagiclink

+ const VerificationTypePhoneChange

+ const VerificationTypeRecovery

+ const VerificationTypeSMS

+ const VerificationTypeSignup

+ var ErrInvalidAdminAuditRequest = errors.New(...)

+ var ErrInvalidAdminUpdateFactorRequest = errors.New("admin update factor request is invalid - nothing to update")

+ var ErrInvalidTokenRequest = errors.New(...)

+ var ErrInvalidVerifyRequest = errors.New(...)

+ type AdminAuditRequest struct

+ Page uint

+ PerPage uint

+ Query *AuditQuery

+ type AdminAuditResponse struct

+ Logs []AuditLogEntry

+ NextPage uint

+ TotalCount int

+ TotalPages uint

+ type AdminCreateSSOProviderRequest struct

+ AttributeMapping SAMLAttributeMapping

+ Domains []string

+ MetadataURL string

+ MetadataXML string

+ ResourceID string

+ Type string

+ type AdminCreateSSOProviderResponse struct

+ type AdminCreateUserRequest struct

+ AppMetadata map[string]interface{}

+ Aud string

+ BanDuration time.Duration

+ Email string

+ EmailConfirm bool

+ Password *string

+ Phone string

+ PhoneConfirm bool

+ Role string

+ UserMetadata map[string]interface{}

+ type AdminCreateUserResponse struct

+ type AdminDeleteSSOProviderRequest struct

+ ProviderID uuid.UUID

+ type AdminDeleteSSOProviderResponse struct

+ type AdminDeleteUserFactorRequest struct

+ FactorID uuid.UUID

+ UserID uuid.UUID

+ type AdminDeleteUserRequest struct

+ UserID uuid.UUID

+ type AdminGenerateLinkRequest struct

+ Data map[string]interface{}

+ Email string

+ NewEmail string

+ Password string

+ RedirectTo string

+ Type LinkType

+ type AdminGenerateLinkResponse struct

+ ActionLink string

+ EmailOTP string

+ HashedToken string

+ RedirectTo string

+ VerificationType LinkType

+ type AdminGetSSOProviderRequest struct

+ ProviderID uuid.UUID

+ type AdminGetSSOProviderResponse struct

+ type AdminGetUserRequest struct

+ UserID uuid.UUID

+ type AdminGetUserResponse struct

+ type AdminListSSOProvidersResponse struct

+ Providers []SSOProvider

+ type AdminListUserFactorsRequest struct

+ UserID uuid.UUID

+ type AdminListUserFactorsResponse struct

+ Factors []Factor

+ type AdminListUsersResponse struct

+ Users []User

+ type AdminUpdateSSOProviderRequest struct

+ AttributeMapping SAMLAttributeMapping

+ Domains []string

+ MetadataURL string

+ MetadataXML string

+ ProviderID uuid.UUID

+ ResourceID string

+ Type string

+ type AdminUpdateSSOProviderResponse struct

+ type AdminUpdateUserFactorRequest struct

+ FactorID uuid.UUID

+ FriendlyName string

+ UserID uuid.UUID

+ type AdminUpdateUserFactorResponse struct

+ type AdminUpdateUserRequest struct

+ AppMetadata map[string]interface{}

+ Aud string

+ BanDuration *BanDuration

+ Email string

+ EmailConfirm bool

+ Password string

+ Phone string

+ PhoneConfirm bool

+ Role string

+ UserID uuid.UUID

+ UserMetadata map[string]interface{}

+ type AdminUpdateUserResponse struct

+ type AuditLogEntry struct

+ CreatedAt time.Time

+ ID uuid.UUID

+ IPAddress string

+ Payload map[string]interface{}

+ type AuditQuery struct

+ Column AuditQueryColumn

+ Value string

+ type AuditQueryColumn string

+ const AuditQueryColumnAction

+ const AuditQueryColumnAuthor

+ const AuditQueryColumnType

+ type AuthorizeRequest struct

+ FlowType FlowType

+ Provider Provider

+ Scopes string

+ type AuthorizeResponse struct

+ AuthorizationURL string

+ Verifier string

+ type BanDuration struct

+ func BanDurationNone() BanDuration

+ func BanDurationTime(d time.Duration) BanDuration

+ func (b *BanDuration) UnmarshalJSON(data []byte) error

+ func (b BanDuration) MarshalJSON() ([]byte, error)

+ func (b BanDuration) String() string

+ func (b BanDuration) Value() *time.Duration

+ type ChallengeFactorRequest struct

+ FactorID uuid.UUID

+ type ChallengeFactorResponse struct

+ ExpiresAt time.Time

+ ID uuid.UUID

+ type EnrollFactorRequest struct

+ FactorType FactorType

+ FriendlyName string

+ Issuer string

+ type EnrollFactorResponse struct

+ ID uuid.UUID

+ TOTP TOTPObject

+ Type FactorType

+ type ErrInvalidGenerateLinkRequest struct

+ func NewErrInvalidGenerateLinkRequest(message string) *ErrInvalidGenerateLinkRequest

+ func (e *ErrInvalidGenerateLinkRequest) Error() string

+ type ExternalProviders struct

+ Apple bool

+ Azure bool

+ Bitbucket bool

+ Discord bool

+ Email bool

+ Facebook bool

+ GitHub bool

+ GitLab bool

+ Google bool

+ Keycloak bool

+ Linkedin bool

+ Notion bool

+ Phone bool

+ SAML bool

+ Slack bool

+ Spotify bool

+ Twitch bool

+ Twitter bool

+ WorkOS bool

+ Zoom bool

+ type Factor struct

+ CreatedAt time.Time

+ FactorType string

+ FriendlyName string

+ ID uuid.UUID

+ Status string

+ UpdatedAt time.Time

+ type FactorType string

+ const FactorTypeTOTP

+ type FlowType string

+ const FlowImplicit

+ const FlowPKCE

+ type GoTrueMetaSecurity struct

+ CaptchaToken string

+ type HealthCheckResponse struct

+ Description string

+ Name string

+ Version string

+ type Identity struct

+ CreatedAt time.Time

+ ID string

+ IdentityData map[string]interface{}

+ LastSignInAt *time.Time

+ Provider string

+ UpdatedAt time.Time

+ UserID uuid.UUID

+ type InviteRequest struct

+ Data map[string]interface{}

+ Email string

+ type InviteResponse struct

+ type LinkType string

+ const LinkTypeEmailChangeCurrent

+ const LinkTypeEmailChangeNew

+ const LinkTypeInvite

+ const LinkTypeMagicLink

+ const LinkTypeRecovery

+ const LinkTypeSignup

+ type MagiclinkRequest struct

+ Email string

+ type OTPRequest struct

+ CreateUser bool

+ Data map[string]interface{}

+ Email string

+ Phone string

+ type PKCEParams struct

+ Challenge string

+ ChallengeMethod string

+ Verifier string

+ type Provider string

+ const ProviderApple

+ const ProviderAzure

+ const ProviderBitbucket

+ const ProviderDiscord

+ const ProviderFacebook

+ const ProviderGitHub

+ const ProviderGitLab

+ const ProviderGoogle

+ const ProviderKeycloak

+ const ProviderLinkedin

+ const ProviderNotion

+ const ProviderSlack

+ const ProviderSpotify

+ const ProviderTwitch

+ const ProviderTwitter

+ const ProviderWorkOS

+ const ProviderZoom

+ type RecoverRequest struct

+ Email string

+ type SAMLAttribute struct

+ Default interface{}

+ Name string

+ Names []string

+ type SAMLAttributeMapping struct

+ Keys map[string]SAMLAttribute

+ type SAMLProvider struct

+ AttributeMapping SAMLAttributeMapping

+ EntityID string

+ MetadataURL *string

+ MetadataXML string

+ type SSODomain struct

+ Domain string

+ type SSOProvider struct

+ CreatedAt time.Time

+ ID uuid.UUID

+ ResourceID *string

+ SAMLProvider SAMLProvider

+ SSODomains []SSODomain

+ UpdatedAt time.Time

+ type SSORequest struct

+ Domain string

+ ProviderID uuid.UUID

+ RedirectTo string

+ SkipHTTPRedirect bool

+ type SSOResponse struct

+ HTTPResponse *http.Response

+ URL string

+ type SecurityEmbed struct

+ Security GoTrueMetaSecurity

+ type Session struct

+ AccessToken string

+ ExpiresAt int64

+ ExpiresIn int

+ RefreshToken string

+ TokenType string

+ User User

+ type SettingsResponse struct

+ Autoconfirm bool

+ DisableSignup bool

+ External ExternalProviders

+ MFAEnabled bool

+ MailerAutoconfirm bool

+ PhoneAutoconfirm bool

+ SmsProvider string

+ type SignupRequest struct

+ Data map[string]interface{}

+ Email string

+ Password string

+ Phone string

+ type SignupResponse struct

+ type TOTPObject struct

+ QRCode string

+ Secret string

+ URI string

+ type TokenRequest struct

+ Code string

+ CodeVerifier string

+ Email string

+ GrantType string

+ Password string

+ Phone string

+ RefreshToken string

+ type TokenResponse struct

+ type UnenrollFactorRequest struct

+ FactorID uuid.UUID

+ type UnenrollFactorResponse struct

+ ID uuid.UUID

+ type UpdateUserRequest struct

+ AppData map[string]interface{}

+ Data map[string]interface{}

+ Email string

+ Nonce string

+ Password *string

+ Phone string

+ type UpdateUserResponse struct

+ type User struct

+ AppMetadata map[string]interface{}

+ Aud string

+ BannedUntil *time.Time

+ ConfirmationSentAt *time.Time

+ ConfirmedAt time.Time

+ CreatedAt time.Time

+ Email string

+ EmailChange string

+ EmailChangeSentAt *time.Time

+ EmailConfirmedAt *time.Time

+ Factors []Factor

+ ID uuid.UUID

+ Identities []Identity

+ InvitedAt *time.Time

+ LastSignInAt *time.Time

+ Phone string

+ PhoneChange string

+ PhoneChangeSentAt *time.Time

+ PhoneConfirmedAt *time.Time

+ ReauthenticationSentAt *time.Time

+ RecoverySentAt *time.Time

+ Role string

+ UpdatedAt time.Time

+ UserMetadata map[string]interface{}

+ type UserResponse struct

+ type VerificationType string

+ type VerifyFactorRequest struct

+ ChallengeID uuid.UUID

+ Code string

+ FactorID uuid.UUID

+ type VerifyFactorResponse struct

+ type VerifyForUserRequest struct

+ Email string

+ Phone string

+ RedirectTo string

+ Token string

+ Type VerificationType

+ type VerifyForUserResponse struct

+ type VerifyRequest struct

+ RedirectTo string

+ Token string

+ Type VerificationType

+ type VerifyResponse struct

+ AccessToken string

+ Error string

+ ErrorCode string

+ ErrorDescription string

+ ExpiresIn int

+ RefreshToken string

+ TokenType string

+ Type VerificationType

+ URL string