v1alpha1

Documentation

Index

• Constants
• type IDPDiscoveryResponse
• type IDPFlow
  • func (r IDPFlow) Equals(s string) bool
  • func (r IDPFlow) String() string
• type IDPType
  • func (r IDPType) Equals(s string) bool
  • func (r IDPType) String() string
• type OIDCDiscoveryResponse
• type OIDCDiscoveryResponseIDPEndpoint
• type PinnipedIDP
• type PinnipedSupportedIDPType

Constants

const (
	IDPTypeOIDC            IDPType = "oidc"
	IDPTypeLDAP            IDPType = "ldap"
	IDPTypeActiveDirectory IDPType = "activedirectory"
	IDPTypeGitHub          IDPType = "github"

	IDPFlowCLIPassword     IDPFlow = "cli_password"
	IDPFlowBrowserAuthcode IDPFlow = "browser_authcode"
)

Types

type IDPDiscoveryResponse

type IDPDiscoveryResponse struct {
	PinnipedIDPs              []PinnipedIDP              `json:"pinniped_identity_providers"`
	PinnipedSupportedIDPTypes []PinnipedSupportedIDPType `json:"pinniped_supported_identity_provider_types"`
}

IDPDiscoveryResponse is the response of a FederationDomain's identity provider discovery endpoint.

type IDPFlow

type IDPFlow string

IDPFlow are the strings that can be returned by the Supervisor identity provider discovery endpoint in the array of allowed client "flows" for each returned identity provider.

func (IDPFlow) Equals

func (r IDPFlow) Equals(s string) bool

Equals is a convenience function for comparing an IDPFlow to a string.

func (IDPFlow) String

func (r IDPFlow) String() string

String is a convenience function to convert an IDPFlow to a string.

type IDPType

type IDPType string

IDPType are the strings that can be returned by the Supervisor identity provider discovery endpoint as the "type" of each returned identity provider.

func (IDPType) Equals

func (r IDPType) Equals(s string) bool

Equals is a convenience function for comparing an IDPType to a string.

func (IDPType) String

func (r IDPType) String() string

String is a convenience function to convert an IDPType to a string.

type OIDCDiscoveryResponse

type OIDCDiscoveryResponse struct {
	SupervisorDiscovery OIDCDiscoveryResponseIDPEndpoint `json:"discovery.supervisor.pinniped.dev/v1alpha1"`
}

OIDCDiscoveryResponse is part of the response from a FederationDomain's OpenID Provider Configuration Document returned by the .well-known/openid-configuration endpoint. It ignores all the standard OpenID Provider configuration metadata and only picks out the portion related to Supervisor identity provider discovery.

type OIDCDiscoveryResponseIDPEndpoint

type OIDCDiscoveryResponseIDPEndpoint struct {
	PinnipedIDPsEndpoint string `json:"pinniped_identity_providers_endpoint"`
}

OIDCDiscoveryResponseIDPEndpoint contains the URL for the identity provider discovery endpoint.

type PinnipedIDP

type PinnipedIDP struct {
	Name  string    `json:"name"`
	Type  IDPType   `json:"type"`
	Flows []IDPFlow `json:"flows,omitempty"`
}

PinnipedIDP describes a single identity provider as included in the response of a FederationDomain's identity provider discovery endpoint.

type PinnipedSupportedIDPType

type PinnipedSupportedIDPType struct {
	Type IDPType `json:"type"`
}

PinnipedSupportedIDPType describes a single identity provider type.