intercom

Documentation

Overview

Package intercom implements the OAuth protocol for authenticating users through Intercom.

Index

• Variables
• type Provider
  • func New(clientKey, secret, callbackURL string, scopes ...string) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) Client() *http.Client
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • func (p *Provider) SetName(name string)
  • func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
• type Session
  • func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)
  • func (s Session) GetAuthURL() (string, error)
  • func (s Session) Marshal() string
  • func (s Session) String() string

Variables

var (
	UserURL string = "https://api.intercom.io/me"
)

Types

type Provider

type Provider struct {
	ClientKey   string
	Secret      string
	CallbackURL string
	HTTPClient  *http.Client
	// contains filtered or unexported fields
}

Provider is the implementation of `goth.Provider` for accessing Intercom

func New

func New(clientKey, secret, callbackURL string, scopes ...string) *Provider

New creates the new Intercom provider

func (*Provider) BeginAuth

func (p *Provider) BeginAuth(state string) (goth.Session, error)

BeginAuth asks Intercom for an authentication end-point

func (*Provider) Client

func (p *Provider) Client() *http.Client

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the intercom package

func (*Provider) FetchUser

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

FetchUser will fetch basic information about Intercom admin

func (*Provider) Name

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken refresh token is not provided by Intercom

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by Intercom

func (*Provider) SetName

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session

type Session struct {
	AuthURL     string
	AccessToken string
	ExpiresAt   time.Time
}

Session stores data during the auth process with intercom.

func (*Session) Authorize

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

Authorize the session with intercom and return the access token to be stored for future use.

func (Session) GetAuthURL

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the intercom provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string