login

Documentation

Overview

Package login implements client login functionality shared between various clients

Package login implements client login functionality shared between various clients

Index

• Variables
• func BuildHeadlessURL(opts ...Option) (u string, err error)
• func Login(ctx context.Context, opts ...Option) (token string, refreshToken string, err error)
• type Error
  • func (e *Error) As(target any) bool
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type OpenBrowserError
  • func (e OpenBrowserError) Error() string
  • func (e OpenBrowserError) Unwrap() error
• type Option
  • func WithAudience(aud []string) Option
  • func WithAuth0Connection(conn string) Option
  • func WithClientID(id string) Option
  • func WithCreateRefreshToken() Option
  • func WithHeadlessCode(code string) Option
  • func WithIdentity(identity string) Option
  • func WithIdentityProvider(idp string) Option
  • func WithInviteCode(inviteCode string) Option
  • func WithIssuer(issuer string) Option
  • func WithMessageWriter(w io.Writer) Option
  • func WithOrgName(org string) Option
  • func WithScope(scope ...string) Option
  • func WithSkipBrowser() Option
  • func WithSkipRegistration() Option

Variables

var (
	HTMLAuthSuccessful = `` /* 2674-byte string literal not displayed */

)

Functions

func BuildHeadlessURL

func BuildHeadlessURL(opts ...Option) (u string, err error)

func Login

func Login(ctx context.Context, opts ...Option) (token string, refreshToken string, err error)

Types

type Error

type Error struct {
	Details string
	Err     error
}

Error is a generic wrapper around client side errors this package may return. It helps callers distinguish between local and remote errors.

func (*Error) As

func (e *Error) As(target any) bool

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

type OpenBrowserError

type OpenBrowserError struct {
	// contains filtered or unexported fields
}

OpenBrowserError wraps the error returned from browser.OpenURL, since this can take a few different forms depending on the OS.

Deprecated: use Error.

func (OpenBrowserError) Error

func (e OpenBrowserError) Error() string

func (OpenBrowserError) Unwrap

func (e OpenBrowserError) Unwrap() error

type Option

type Option func(opt *config)

func WithAudience

func WithAudience(aud []string) Option

func WithAuth0Connection

func WithAuth0Connection(conn string) Option

func WithClientID

func WithClientID(id string) Option

func WithCreateRefreshToken

func WithCreateRefreshToken() Option

func WithHeadlessCode

func WithHeadlessCode(code string) Option

func WithIdentity

func WithIdentity(identity string) Option

func WithIdentityProvider

func WithIdentityProvider(idp string) Option

func WithInviteCode

func WithInviteCode(inviteCode string) Option

func WithIssuer

func WithIssuer(issuer string) Option

func WithMessageWriter

func WithMessageWriter(w io.Writer) Option

func WithOrgName

func WithOrgName(org string) Option

func WithScope

func WithScope(scope ...string) Option

func WithSkipBrowser

func WithSkipBrowser() Option

func WithSkipRegistration

func WithSkipRegistration() Option