providers

Documentation

Index

• type Provider
  • func New(providerType *unikornv1.IdentityProviderType) Provider

Types

type Provider

type Provider interface {
	// AuthorizationRequestParameters allows the autorization request parameters
	// to be tweaked on a per-provider basis.
	AuthorizationRequestParameters() map[string]string

	// Scopes returns a set of scopes that are required by the access token
	// to operate correctly.
	Scopes() []string

	// RequiresAccessToken defines whether the access and refresh tokens are
	// required for operation.
	// TODO: this is because Microsoft's tokens are massive and blow nginx's
	// request size limit (4096).  We really need to cache these securely and
	// internally so we don't have to pass them around.  For example hand to
	// the client an ID and private key that can decrpyt from storage, in memory
	// on demand.
	RequiresAccessToken() bool

	// Groups returns a list of groups the user belongs to.
	Groups(ctx context.Context, organization *unikornv1.Organization, accessToken string) ([]types.Group, error)
}

func New

func New(providerType *unikornv1.IdentityProviderType) Provider