github

Documentation

Index

• func NewThirdPartyAuthHelper(config ThirdPartyAuthHelperConfig) api.ThirdPartyAuthHelper
• type ThirdPartyAuthHelperConfig

Functions

func NewThirdPartyAuthHelper

func NewThirdPartyAuthHelper(
	config ThirdPartyAuthHelperConfig,
) api.ThirdPartyAuthHelper

Types

type ThirdPartyAuthHelperConfig

type ThirdPartyAuthHelperConfig struct {
	// ClientID is the client ID for a GitHub OAuth App.
	ClientID string
	// ClientSecret is the client secret for a GitHub OAuth App.
	ClientSecret string
	// AllowedOrganizations enumerates GitHub organizations for which members may
	// authenticate to Brigade. If this list is non-empty, principals who are not
	// members of any of the enumerated organizations will be unable to
	// authenticate successfully.
	AllowedOrganizations []string
}

ThirdPartyAuthHelperConfig encapsulates configuration for the GitHub-based implementation of the authn.ThirdPartyAuthHelper interface.