goth: Index | Files

package salesforce

import ""

Package salesforce implements the OAuth2 protocol for authenticating users through salesforce. This package can be used as a reference implementation of an OAuth2 provider for Goth.


Package Files

salesforce.go session.go


var (
    AuthURL  string = ""
    TokenURL string = ""

These vars define the Authentication and Token URLS for Salesforce. If using Salesforce Community, you should change these values before calling New.


salesforce.AuthURL = "
salesforce.TokenURL = "

type Provider Uses

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 Salesforce.

func New Uses

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

New creates a new Salesforce provider and sets up important connection details. You should always call `salesforce.New` to get a new provider. Never try to create one manually.

func (*Provider) BeginAuth Uses

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

BeginAuth asks Salesforce for an authentication end-point.

func (*Provider) Client Uses

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

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is a no-op for the salesforce package.

func (*Provider) FetchUser Uses

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

FetchUser will go to Salesforce and access basic information about the user.

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

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

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName Uses

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 Uses

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

UnmarshalSession wil unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL      string
    AccessToken  string
    RefreshToken string
    ID           string //Required to get the user info from sales force

Session stores data during the auth process with Salesforce. Expiry of access token is not provided by Salesforce, it is just controlled by timeout configured in auth2 settings by individual users Only way to check whether access token has expired or not is based on the response you receive if you try using access token and get some error Also, For salesforce refresh token to work follow these else remove scopes from here On, navigate to where you app is configured. (Setup > Create > Apps) Under Connected Apps, click on your application's name to view its settings, then click Edit. Under Selected OAuth Scopes, ensure that "Perform requests on your behalf at any time" is selected. You must include this even if you already chose "Full access". Save, then try your OAuth flow again. It make take a short while for the update to propagate.

func (*Session) Authorize Uses

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

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

func (Session) GetAuthURL Uses

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

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

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package salesforce imports 9 packages (graph) and is imported by 37 packages. Updated 2019-06-22. Refresh now. Tools for package owners.