Documentation
¶
Index ¶
Constants ¶
View Source
const ( // WebConfigAuthProviderOIDCType is OIDC provider type WebConfigAuthProviderOIDCType = "oidc" // WebConfigAuthProviderOIDCURL is OIDC webapi endpoint WebConfigAuthProviderOIDCURL = "/v1/webapi/oidc/login/web?redirect_url=:redirect&connector_id=:providerName" // WebConfigAuthProviderSAMLType is SAML provider type WebConfigAuthProviderSAMLType = "saml" // WebConfigAuthProviderSAMLURL is SAML webapi endpoint WebConfigAuthProviderSAMLURL = "/v1/webapi/saml/sso?redirect_url=:redirect&connector_id=:providerName" // WebConfigAuthProviderGitHubType is GitHub provider type WebConfigAuthProviderGitHubType = "github" // WebConfigAuthProviderGitHubURL is GitHub webapi endpoint WebConfigAuthProviderGitHubURL = "/v1/webapi/github/login/web?redirect_url=:redirect&connector_id=:providerName" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Cluster ¶
type Cluster struct {
// Name is the cluster name
Name string `json:"name"`
// LastConnected is the cluster last connected time
LastConnected time.Time `json:"lastConnected"`
// Status is the cluster status
Status string `json:"status"`
// NodeCount is this cluster number of registered servers
NodeCount int `json:"nodeCount"`
// PublicURL is this cluster public URL (its first available proxy URL),
// or possibly empty if no proxies could be loaded.
PublicURL string `json:"publicURL"`
// AuthVersion is the cluster auth's service version
AuthVersion string `json:"authVersion"`
// ProxyVersion is the cluster proxy's service version,
// or possibly empty if no proxies could be loaded.
ProxyVersion string `json:"proxyVersion"`
}
Cluster describes a cluster
func GetClusterDetails ¶
func GetClusterDetails(site reversetunnel.RemoteSite) (*Cluster, error)
GetClusterDetails retrieves and sets details about a cluster
func NewClusters ¶
func NewClusters(remoteClusters []reversetunnel.RemoteSite) ([]Cluster, error)
NewClusters creates a slice of Cluster's, containing data about each cluster.
type Label ¶
type Label struct {
// Name is this label name
Name string `json:"name"`
// Value is this label value
Value string `json:"value"`
}
Label describes label for webapp
type ResetPasswordToken ¶
type ResetPasswordToken struct {
// TokenID is token ID
TokenID string `json:"tokenId"`
// User is user name associated with this token
User string `json:"user"`
// QRCode is a QR code value
QRCode []byte `json:"qrCode,omitempty"`
// URL is token URL
URL string `json:"url,omitempty"`
// Expiry is token expiration time
Expiry time.Time `json:"expiry,omitempty"`
}
ResetPasswordToken describes ResetPasswordToken UI object
type Server ¶
type Server struct {
// Tunnel indicates of this server is connected over a reverse tunnel.
Tunnel bool `json:"tunnel"`
// Name is this server name
Name string `json:"id"`
// ClusterName is this server cluster name
ClusterName string `json:"siteId"`
// Hostname is this server hostname
Hostname string `json:"hostname"`
// Addrr is this server ip address
Addr string `json:"addr"`
// Labels is this server list of labels
Labels []Label `json:"tags"`
}
Server describes a server for webapp
type WebConfig ¶
type WebConfig struct {
// Auth contains Teleport auth. preferences
Auth WebConfigAuthSettings `json:"auth,omitempty"`
// CanJoinSessions disables joining sessions
CanJoinSessions bool `json:"canJoinSessions"`
// ProxyClusterName is the name of the local cluster
ProxyClusterName string `json:"proxyCluster,omitempty"`
}
WebConfig is web application configuration
type WebConfigAuthProvider ¶
type WebConfigAuthProvider struct {
// Name is this provider ID
Name string `json:"name,omitempty"`
// DisplayName is this provider display name
DisplayName string `json:"displayName,omitempty"`
// Type is this provider type
Type string `json:"type,omitempty"`
// WebAPIURL is this provider webapi URL
WebAPIURL string `json:"url,omitempty"`
}
WebConfigAuthProvider describes auth. provider
type WebConfigAuthSettings ¶
type WebConfigAuthSettings struct {
// SecondFactor is the type of second factor to use in authentication.
SecondFactor string `json:"second_factor,omitempty"`
// Providers contains a list of configured auth providers
Providers []WebConfigAuthProvider `json:"providers,omitempty"`
// LocalAuthEnabled is a flag that enables local authentication
LocalAuthEnabled bool `json:"localAuthEnabled"`
}
WebConfigAuthSettings describes auth configuration
Click to show internal directories.
Click to hide internal directories.