Documentation
¶
Index ¶
- Constants
- func IsInvalidConfig(err error) bool
- func IsMissingCallbackURI(err error) bool
- func IsNotFound(err error) bool
- func IsRequestFailed(err error) bool
- type Config
- type Github
- func (g *Github) CleanCredentialsForAuthenticatedApp(config provider.AppConfig) error
- func (g *Github) CreateApp(config provider.AppConfig) (*githubclient.AppConfig, error)
- func (g *Github) CreateOrUpdateApp(config provider.AppConfig, ctx context.Context, oldConnector dex.Connector) (provider.ProviderApp, error)
- func (g *Github) DeleteApp(name string, ctx context.Context) error
- func (g *Github) DeleteAuthenticatedApp(config provider.AppConfig) error
- func (g *Github) GetAppData(app *githubclient.AppConfig) Config
- func (g *Github) GetCredentialsForAuthenticatedApp(config provider.AppConfig) (map[string]string, error)
- func (g *Github) GetName() string
- func (g *Github) GetOwner() string
- func (g *Github) GetProviderName() string
- func (g *Github) GetType() string
- func (g *Github) RotateServiceCredentials(ctx context.Context, config provider.AppConfig) (map[string]string, error)
- func (g *Github) ShouldRotateServiceCredentials(ctx context.Context, config provider.AppConfig) (bool, error)
- func (g *Github) SupportsServiceCredentialRenewal() bool
- func (g *Github) UpdateNeeded(app *githubclient.App, config provider.AppConfig) bool
Constants ¶
View Source
const ( ProviderName = "github" ProviderDisplayName = "Github" ProviderConnectorType = "github" OrganizationKey = "organization" TeamKey = "team" AppIDKey = "app-id" PrivateKeyKey = "private-key" ClientIDKey = "client-id" ClientSecretKey = "client-secret" DefaultHost = "github.com" TeamNameFieldSlug = "slug" // PreferredEmailDomainKey is an optional credential key. When set, the // rendered connector config carries preferredEmailDomain, making dex // (>= v2.36.0) release the user's verified email on that domain instead // of the GitHub primary email. PreferredEmailDomainKey = "preferred-email-domain" // TeamsKey is an optional credential key holding a comma-separated list // of team slugs. When set it takes precedence over TeamKey: dex lets a // user log in when they are a member of ANY listed team, and the groups // claim carries the user's memberships among the listed teams. Operator // versions without this key ignore it, so a credential may carry both // keys and deploy in any order — but TeamKey's value must then appear in // the list, so no operator version can render a filter that drops it. TeamsKey = "teams" )
Variables ¶
This section is empty.
Functions ¶
func IsInvalidConfig ¶
IsInvalidcConfig asserts invalidConfigError.
func IsMissingCallbackURI ¶
IsMissingCallbackURI asserts missingCallbackURIError.
func IsRequestFailed ¶
IsRequestFailed asserts requestFailedError.
Types ¶
type Github ¶
type Github struct {
Client *githubclient.Client
Log logr.Logger
Name string
Description string
Type string
Owner string
Organization string
Teams []string
PreferredEmailDomain string
// contains filtered or unexported fields
}
func (*Github) CleanCredentialsForAuthenticatedApp ¶
func (*Github) CreateOrUpdateApp ¶
func (*Github) DeleteAuthenticatedApp ¶ added in v0.5.0
func (*Github) GetAppData ¶
func (g *Github) GetAppData(app *githubclient.AppConfig) Config
func (*Github) GetCredentialsForAuthenticatedApp ¶
func (*Github) GetProviderName ¶
func (*Github) RotateServiceCredentials ¶ added in v0.14.0
func (*Github) ShouldRotateServiceCredentials ¶ added in v0.14.0
func (*Github) SupportsServiceCredentialRenewal ¶ added in v0.14.0
Self-renewal methods implementation - Github doesn't support renewal yet
func (*Github) UpdateNeeded ¶
Click to show internal directories.
Click to hide internal directories.