Module types 

Structs

AdminUserListResponse

Paginated list of users returned by admin endpoints.

AmrEntry

Authentication Method Reference entry from the JWT.

AuthResponse

Response from sign-up and some auth operations.

AuthStateChange

An auth state change notification, containing the event type and optional session.

AuthSubscription

Subscription handle for auth state change events.

AuthenticatorAssuranceLevelInfo

Authenticator assurance level info.

AutoRefreshConfig

Configuration for automatic token refresh.

Factor

An MFA factor.

Identity

A linked auth provider identity.

Jwk

Individual JSON Web Key.

JwksResponse

JSON Web Key Set response.

LinkIdentityResponse

Response from identity link (returns redirect URL).

MfaChallengeResponse

Response from MFA challenge.

MfaEnrollResponse

Response from MFA enroll.

MfaListFactorsResponse

Categorized list of enrolled MFA factors.

MfaTotpInfo

TOTP-specific info from MFA enroll.

MfaUnenrollResponse

Response from MFA unenroll.

OAuthAuthorizationClient

OAuth authorization client info (subset shown during consent).

OAuthAuthorizationDetails

OAuth authorization details (consent screen data).

OAuthAuthorizationUser

User info in authorization details.

OAuthClient

A registered OAuth client.

OAuthClientListResponse

Paginated list of OAuth clients.

OAuthGrant

A granted OAuth permission.

OAuthRedirect

Redirect response from authorization consent.

OAuthTokenResponse

OAuth token response from the /oauth/token endpoint.

OpenIdConfiguration

OpenID Connect discovery document.

PkceCodeChallenge

PKCE code challenge (S256 hash of the verifier, base64url-encoded).

PkceCodeVerifier

PKCE code verifier (random string, 43-128 unreserved characters).

PkcePair

A PKCE verifier/challenge pair for OAuth 2.1 authorization code flow.

Session

A user session returned from sign-in, sign-up, or token refresh.

SsoSignInResponse

Response from SSO sign-in.

User

A GoTrue user object.

Web3SignInParams

Parameters for signing in with a Web3 wallet.

Enums

AuthChangeEvent

Auth state change event types.

AuthenticatorAssuranceLevel

Authenticator Assurance Level.

FactorStatus

MFA factor status.

FactorType

MFA factor type.

OAuthAuthorizationDetailsResponse

Response from getAuthorizationDetails — either details or a redirect.

OAuthClientGrantType

OAuth client grant type.

OAuthClientRegistrationType

OAuth client registration type.

OAuthClientResponseType

OAuth client response type.

OAuthClientType

OAuth client type (public or confidential).

OAuthProvider

Supported OAuth providers.

OtpChannel

OTP delivery channel for phone-based OTP.

OtpType

OTP verification type.

SignOutScope

Scope for sign-out operations.

Web3Chain

Blockchain type for Web3 wallet authentication.