github

Documentation

Index

• type GitHubAuthenticator
  • func (a *GitHubAuthenticator) GetAuthRedirect() (string, string)
  • func (a *GitHubAuthenticator) GetTokens(code string) (*GitHubToken, error)
  • func (a *GitHubAuthenticator) GetUsernameWithToken(accessToken string) (string, error)
• type GitHubToken

Types

type GitHubAuthenticator

type GitHubAuthenticator struct {
	ClientId     string
	ClientSecret string
}

func (*GitHubAuthenticator) GetAuthRedirect

func (a *GitHubAuthenticator) GetAuthRedirect() (string, string)

GetAuthRedirect returns a redirect URL and a state parameter that should be stored in the user's browser to correlate the authentication result and request.

func (*GitHubAuthenticator) GetTokens

func (a *GitHubAuthenticator) GetTokens(code string) (*GitHubToken, error)

GetTokens returns the GitHub Oauth tokens from the service given a token request code. The returned tokens are used for authentication to the GitHub API.

This relies on a GitHub Oauth application on the GitHub side to act as the client for these tokens.

func (*GitHubAuthenticator) GetUsernameWithToken

func (a *GitHubAuthenticator) GetUsernameWithToken(accessToken string) (string, error)

GetUsernameWithToken returns the authenticated user's GitHub username given an Oauth auth token.

type GitHubToken

type GitHubToken struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
}