github

Documentation

Overview

Package github provides authentication strategies using GitHub.

Index

• type Config
  • func (c *Config) Open(id string, logger logrus.FieldLogger) (connector.Connector, error)
• type Org

Types

type Config

type Config struct {
	ClientID      string `json:"clientID"`
	ClientSecret  string `json:"clientSecret"`
	RedirectURI   string `json:"redirectURI"`
	Org           string `json:"org"`
	Orgs          []Org  `json:"orgs"`
	HostName      string `json:"hostName"`
	RootCA        string `json:"rootCA"`
	TeamNameField string `json:"teamNameField"`
}

Config holds configuration options for github logins.

func (*Config) Open

func (c *Config) Open(id string, logger logrus.FieldLogger) (connector.Connector, error)

Open returns a strategy for logging in through GitHub.

type Org

type Org struct {

	// Organization name in github (not slug, full name). Only users in this github
	// organization can authenticate.
	Name string `json:"name"`

	// Names of teams in a github organization. A user will be able to
	// authenticate if they are members of at least one of these teams. Users
	// in the organization can authenticate if this field is omitted from the
	// config file.
	Teams []string `json:"teams,omitempty"`
}

Org holds org-team filters, in which teams are optional.