Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// User is the configuration for the user to create.
User UserConfig `json:"user"`
// Workspace is the configuration for the workspace to create. The workspace
// will be built using the new user.
//
// OrganizationID is ignored and set to the new user's organization ID.
Workspace workspacebuild.Config `json:"workspace"`
// ReconnectingPTY is the configuration for web terminal connections to the
// new workspace. If nil, no web terminal connections will be made. Runs in
// parallel to agent connections if specified.
//
// AgentID is ignored and set to the new workspace's agent ID.
ReconnectingPTY *reconnectingpty.Config `json:"reconnecting_pty"`
// AgentConn is the configuration for connections made to the agent. If nil,
// no agent connections will be made. Runs in parallel to reconnecting pty
// connections if specified.
//
// AgentID is ignored and set to the new workspace's agent ID.
AgentConn *agentconn.Config `json:"agent_conn"`
// NoCleanup determines whether the user and workspace should be left as is
// and not deleted or stopped in any way.
NoCleanup bool `json:"no_cleanup"`
}
type Runner ¶
type Runner struct {
// contains filtered or unexported fields
}
type UserConfig ¶
type UserConfig struct {
// OrganizationID is the ID of the organization to add the user to.
OrganizationID uuid.UUID `json:"organization_id"`
// Username is the username of the new user.
Username string `json:"username"`
// Email is the email of the new user.
Email string `json:"email"`
// SessionToken is the session token of an already existing user. If set, no
// user will be created.
SessionToken string `json:"session_token"`
}
func (UserConfig) Validate ¶
func (c UserConfig) Validate() error
Click to show internal directories.
Click to hide internal directories.