oauth

Documentation

Overview

Package oauth contains the oauth utilities for the platform

Index

• Constants
• func Info(ctx context.Context, appCtx *config.AppContext, agent Agent) (*config.UserInfo, error)
• type Agent
• type UserInfoMap

Constants

const (
	//GOOGLE is google oauth agent string
	GOOGLE = "GOOGLE"
)

Functions

func Info

func Info(ctx context.Context, appCtx *config.AppContext, agent Agent) (*config.UserInfo, error)

Info returns the userinfo of a given user from the oauth agent

Types

type Agent

type Agent interface {
	//Info returns the user info for a given app context
	Info(context.Context, *config.AppContext) (*config.UserInfo, error)
	//Name is the name of the auth agent
	Name() string
}

Agent is the oauth agent interface to be implmented. OAuth agents are google, facebook etc.

type UserInfoMap

type UserInfoMap struct {
	Email   string //Email key of the user info model
	Name    string //Name key of the user info model
	Picture string //Picture url key of the user info model
}

UserInfoMap contains the string of the keywords to be used to retrieve the user info from the api respose of the auth agent like Google, Facebook etc.