Docs menu: vestibule/auth

vestibule/auth

Authentication result types returned to the calling application after a successful OAuth/OIDC flow.

vestibule/auth

Authentication result types returned to the calling application after a successful OAuth/OIDC flow.

Types

Auth

The normalized result of a successful authentication.

Opaque so the field set can grow in future releases. Callers build instances with auth.new and read fields with accessors; they cannot pattern match on fields.

pub type Auth

Functions

credentials

Return the OAuth credentials (tokens, expiry).

pub fn credentials(Auth) -> credentials.Credentials

extra

Return the provider-specific extra data.

pub fn extra(Auth) -> dict.Dict(String, dynamic.Dynamic)

info

Return the normalized user information.

pub fn info(Auth) -> user_info.UserInfo

new

Construct an authentication result.

pub fn new(
  uid: String,
  provider: String,
  info: user_info.UserInfo,
  credentials: credentials.Credentials,
  extra: dict.Dict(String, dynamic.Dynamic)
) -> Auth

provider

Return the provider name matching the strategy.

pub fn provider(Auth) -> String

uid

Return the unique identifier from the provider (e.g., GitHub user ID).

pub fn uid(Auth) -> String