createworkspaces
package v2.23.0
Go to latest Published: Jun 3, 2025 License:AGPL-3.0
Opens a new window with list of versions in this module.
Latest LatestThis package is not in the latest version of its module.
Opens a new window with license information.
Imports:16 Opens a new window with list of imports.
Imported by:0 Opens a new window with list of known importers.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeConfig¶
type Config struct {// User is the configuration for the user to create.UserUserConfig `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.Workspaceworkspacebuild.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.NoCleanupbool `json:"no_cleanup"`}
typeRunner¶
type Runner struct {// contains filtered or unexported fields}
typeUserConfig¶
type UserConfig struct {// OrganizationID is the ID of the organization to add the user to.OrganizationIDuuid.UUID `json:"organization_id"`// Username is the username of the new user.Usernamestring `json:"username"`// Email is the email of the new user.Emailstring `json:"email"`// SessionToken is the session token of an already existing user. If set, no// user will be created.SessionTokenstring `json:"session_token"`}
func (UserConfig)Validate¶
func (cUserConfig) Validate()error
Click to show internal directories.
Click to hide internal directories.