auth

Documentation

Index

• Constants
• type AccessKey
• type Info
• type InfoMethods
• type MethodPassword
• type MethodRancher
• type MethodSSO
• type OIDCRedirect
• type OIDCRefreshRequest
• type OIDCToken
• type OIDCTokenRequest
• type PasswordLoginRequest
• type Token
• type TokenRequest
• type Version

Constants

const GroupVersion = "authentication.loft.sh/v1"

Types

type AccessKey

type AccessKey struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	User      string `json:"user"`
	Username  string `json:"username"`
	AccessKey string `json:"accessKey"`
}

type Info

type Info struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Methods InfoMethods `json:"methods,omitempty"`
}

type InfoMethods

type InfoMethods struct {
	SSO      []*MethodSSO    `json:"sso,omitempty"`
	Rancher  *MethodRancher  `json:"rancher,omitempty"`
	Password *MethodPassword `json:"password,omitempty"`
}

type MethodPassword

type MethodPassword struct {
	// Indicates if the authentication method is enabled
	Enabled bool `json:"enabled,omitempty"`
}

type MethodRancher

type MethodRancher struct {
	// Indicates if the authentication method is enabled
	Enabled bool `json:"enabled,omitempty"`

	// Host is the rancher host to use for redirects
	Host string `json:"host,omitempty"`
}

type MethodSSO

type MethodSSO struct {
	// ID of the SSO to show in the UI. Only for displaying purposes
	ID string `json:"id,omitempty"`

	// DisplayName of the SSO to show in the UI. Only for displaying purposes
	DisplayName string `json:"displayName,omitempty"`

	// LoginEndpoint is the path the UI will request a login url from
	LoginEndpoint string `json:"loginEndpoint,omitempty"`

	// LogoutEndpoint is the path the UI will request a logout url from
	LogoutEndpoint string `json:"logoutEndpoint,omitempty"`
}

type OIDCRedirect

type OIDCRedirect struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Redirect string `json:"redirect,omitempty"`

	// SAML specific values
	SamlID   string `json:"samlId,omitempty"`
	SamlData string `json:"samlData,omitempty"`
}

type OIDCRefreshRequest

type OIDCRefreshRequest struct {
	RefreshToken string `json:"refreshToken,omitempty"`
}

OIDCRefreshRequest is used by the /auth/oidc/refresh route

type OIDCToken

type OIDCToken struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	IDToken      string `json:"idToken"`
	AccessToken  string `json:"accessToken"`
	RefreshToken string `json:"refreshToken"`
}

type OIDCTokenRequest

type OIDCTokenRequest struct {
	Token       string `json:"token,omitempty"`
	AccessToken string `json:"accessToken,omitempty"`
}

OIDCTokenRequest is used by the /auth/oidc/token route

type PasswordLoginRequest

type PasswordLoginRequest struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

PasswordLoginRequest is used by the /auth/password/login route

type Token

type Token struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Token string `json:"token"`
}

type TokenRequest

type TokenRequest struct {
	Key string `json:"key,omitempty"`
}

TokenRequest is used by the /auth/token route

type Version

type Version struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Version string `json:"version"`
	Major   string `json:"major,omitempty"`
	Minor   string `json:"minor,omitempty"`

	KubeVersion string `json:"kubeVersion,omitempty"`

	NewerVersion  string `json:"newerVersion,omitempty"`
	ShouldUpgrade bool   `json:"shouldUpgrade,omitempty"`
}