github

Documentation

Overview

Package github contains a directory provider for github.

Index

• Constants
• type Option
  • func WithHTTPClient(httpClient *http.Client) Option
  • func WithServiceAccount(serviceAccount *ServiceAccount) Option
  • func WithURL(u *url.URL) Option
• type Provider
  • func New(options ...Option) *Provider
  • func (p *Provider) User(ctx context.Context, userID, accessToken string) (*directory.User, error)
  • func (p *Provider) UserGroups(ctx context.Context) ([]*directory.Group, []*directory.User, error)
• type ServiceAccount
  • func ParseServiceAccount(rawServiceAccount string) (*ServiceAccount, error)

Constants

const Name = "github"

Name is the provider name.

Types

type Option

type Option func(cfg *config)

An Option updates the github configuration.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient sets the http client option.

func WithServiceAccount

func WithServiceAccount(serviceAccount *ServiceAccount) Option

WithServiceAccount sets the service account in the config.

func WithURL

func WithURL(u *url.URL) Option

WithURL sets the api url in the config.

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

The Provider retrieves users and groups from github.

func New

func New(options ...Option) *Provider

New creates a new Provider.

func (*Provider) User

func (p *Provider) User(ctx context.Context, userID, accessToken string) (*directory.User, error)

User returns the user record for the given id.

func (*Provider) UserGroups

func (p *Provider) UserGroups(ctx context.Context) ([]*directory.Group, []*directory.User, error)

UserGroups gets the directory user groups for github.

type ServiceAccount

type ServiceAccount struct {
	Username            string `json:"username"`
	PersonalAccessToken string `json:"personal_access_token"`
}

A ServiceAccount is used by the GitHub provider to query the GitHub API.

func ParseServiceAccount

func ParseServiceAccount(rawServiceAccount string) (*ServiceAccount, error)

ParseServiceAccount parses the service account in the config options.