oauth2x

Documentation

Index

• func Authorize(redirect string) (string, error)
• func GetDisplayName() string
• func Init(cf Config)
• type CallbackOutput
  • func Callback(ctx context.Context, code, state string) (*CallbackOutput, error)
• type Config

Functions

func Authorize

func Authorize(redirect string) (string, error)

Authorize return the sso authorize location with state

func GetDisplayName

func GetDisplayName() string

func Init

func Init(cf Config)

Types

type CallbackOutput

type CallbackOutput struct {
	Redirect    string `json:"redirect"`
	Msg         string `json:"msg"`
	AccessToken string `json:"accessToken"`
	Username    string `json:"username"`
	Nickname    string `json:"nickname"`
	Phone       string `yaml:"phone"`
	Email       string `yaml:"email"`
}

func Callback

func Callback(ctx context.Context, code, state string) (*CallbackOutput, error)

Callback 用 code 兑换 accessToken 以及 用户信息

type Config

type Config struct {
	Enable          bool
	DisplayName     string
	RedirectURL     string
	SsoAddr         string
	TokenAddr       string
	UserInfoAddr    string
	TranTokenMethod string
	ClientId        string
	ClientSecret    string
	CoverAttributes bool
	Attributes      struct {
		Username string
		Nickname string
		Phone    string
		Email    string
	}
	DefaultRoles    []string
	UserinfoIsArray bool
	UserinfoPrefix  string
	Scopes          []string
}