goth: github.com/markbates/goth/providers/azuread Index | Files

package azuread

import "github.com/markbates/goth/providers/azuread"

Package azuread implements the OAuth2 protocol for authenticating users through AzureAD. This package can be used as a reference implementation of an OAuth2 provider for Goth. To use microsoft personal account use microsoftonline provider

Index

Package Files

azuread.go session.go

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

func New Uses

❖
func New(clientKey, secret, callbackURL string, resources []string, scopes ...string) *Provider

New creates a new AzureAD provider, and sets up important connection details. You should always call `AzureAD.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 AzureAD for an authentication end-point.

func (*Provider) Client Uses

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

Client is HTTP client to be used in all fetch operations.

func (*Provider) Debug Uses

❖
func (p *Provider) Debug(debug bool)

Debug is a no-op for the package.

func (*Provider) FetchUser Uses

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

FetchUser will go to AzureAD 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
    ExpiresAt    time.Time
}

Session is the implementation of `goth.Session` for accessing AzureAD.

func (*Session) Authorize Uses

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

Authorize the session with AzureAD 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 Facebook 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 azuread imports 10 packages (graph) and is imported by 9 packages. Updated 2018-09-08. Refresh now. Tools for package owners.