oidc

Documentation

Index

• Constants
• func RegisterAPIHandler(e *echo.Echo, s *Service)
• type IDTokenClaims
• type Service
  • func New(db *db.PgDB, config config.OIDCConfig, pachEnabled bool) (*Service, error)

Constants

const (
	OidcRoot     = "/oidc"
	CallbackPath = "/callback"
	InitiatePath = "/sso"
)

Default paths for handling OIDC requests.

Functions

func RegisterAPIHandler

func RegisterAPIHandler(e *echo.Echo, s *Service)

RegisterAPIHandler enables OIDC-related endpoints.

Types

type IDTokenClaims

type IDTokenClaims struct {
	AuthenticationClaim string   `json:"authentication_claim"`
	DisplayName         string   `json:"display_name"`
	AgentUID            int      `json:"agent_uid"`
	AgentGID            int      `json:"agent_gid"`
	AgentUserName       string   `json:"agent_user_name"`
	AgentGroupName      string   `json:"agent_group_name"`
	AgentUIDSet         bool     `json:"agent_uid_set"`
	AgentGIDSet         bool     `json:"agent_gid_set"`
	Groups              []string `json:"groups"`
}

IDTokenClaims represents the set of claims in an OIDC ID token that we're concerned with.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service handles OIDC interactions.

func New

func New(db *db.PgDB, config config.OIDCConfig, pachEnabled bool) (*Service, error)

New initiates an OIDC Service.