func BitmapToWeekdays(bitmapuint8) []string

func DefaultCacheDir()string

func DefaultDocsURL()string

func DeploymentOptionsWithoutSecrets(setserpent.OptionSet)serpent.OptionSet

func DiscoverVarsFiles(workDirstring) ([]string,error)

func DisplayNameValid(strstring)error

func ExpectJSONMime(res *http.Response)error

func GroupNameValid(strstring)error

func IsConnectionError(errerror)bool

func IsSecretDeploymentOption(optserpent.Option)bool

func IsWorkspaceProxies(optserpent.Option)bool

func JobIsMissingParameterErrorCode(codeJobErrorCode)bool

func NameValid(strstring)error

func NormalizeRealUsername(strstring)string

func ParseSSHConfigOption(optstring) (keystring, valuestring, errerror)

func ProvisionerTypeValid[TProvisionerType |string](pt T)error

func ReadBodyAsError(res *http.Response)error

func ReservedProvisionerKeyNames() []string

func ServerSentEventReader(ctxcontext.Context, rcio.ReadCloser) func() (*ServerSentEvent,error)

func TemplateVersionNameValid(strstring)error

func TimezoneOffsetHour(loc *time.Location)int

func TimezoneOffsetHourWithTime(nowtime.Time, loc *time.Location)int

func UserRealNameValid(strstring)error

func UsernameFrom(strstring)string

func ValidateNewWorkspaceParameters(richParameters []TemplateVersionParameter, buildParameters []WorkspaceBuildParameter)error

func ValidateWorkspaceBuildParameter(richParameterTemplateVersionParameter, buildParameter *WorkspaceBuildParameter, lastBuildParameter *WorkspaceBuildParameter)error

func ValidateWorkspaceBuildParameters(richParameters []TemplateVersionParameter, buildParameters, lastBuildParameters []WorkspaceBuildParameter)error

func WebsocketNetConn(ctxcontext.Context, conn *websocket.Conn, msgTypewebsocket.MessageType) (context.Context,net.Conn)

func WeekdaysToBitmap(days []string) (uint8,error)

func WorkspaceDisplayStatus(jobStatusProvisionerJobStatus, transitionWorkspaceTransition)string

type ACLAvailable struct {Users  []ReducedUser `json:"users"`Groups []Group       `json:"groups"`}

type AIConfig struct {Providers []AIProviderConfig `json:"providers,omitempty" yaml:"providers,omitempty"`}

type AIProviderConfig struct {// Type is the type of the API provider.Typestring `json:"type" yaml:"type"`// APIKey is the API key to use for the API provider.APIKeystring `json:"-" yaml:"api_key"`// Models is the list of models to use for the API provider.Models []string `json:"models" yaml:"models"`// BaseURL is the base URL to use for the API provider.BaseURLstring `json:"base_url" yaml:"base_url"`}

type APIKey struct {IDstring      `json:"id" validate:"required"`UserIDuuid.UUID   `json:"user_id" validate:"required" format:"uuid"`LastUsedtime.Time   `json:"last_used" validate:"required" format:"date-time"`ExpiresAttime.Time   `json:"expires_at" validate:"required" format:"date-time"`CreatedAttime.Time   `json:"created_at" validate:"required" format:"date-time"`UpdatedAttime.Time   `json:"updated_at" validate:"required" format:"date-time"`LoginTypeLoginType   `json:"login_type" validate:"required" enums:"password,github,oidc,token"`ScopeAPIKeyScope `json:"scope" validate:"required" enums:"all,application_connect"`TokenNamestring      `json:"token_name" validate:"required"`LifetimeSecondsint64       `json:"lifetime_seconds" validate:"required"`}

type APIKeyScopestring

type APIKeyWithOwner struct {APIKeyUsernamestring `json:"username"`}

type AddLicenseRequest struct {Licensestring `json:"license" validate:"required"`}

type AgentConnectionTiming struct {StartedAttime.Time   `json:"started_at" format:"date-time"`EndedAttime.Time   `json:"ended_at" format:"date-time"`StageTimingStage `json:"stage"`WorkspaceAgentIDstring      `json:"workspace_agent_id"`WorkspaceAgentNamestring      `json:"workspace_agent_name"`}

type AgentScriptTiming struct {StartedAttime.Time   `json:"started_at" format:"date-time"`EndedAttime.Time   `json:"ended_at" format:"date-time"`ExitCodeint32       `json:"exit_code"`StageTimingStage `json:"stage"`Statusstring      `json:"status"`DisplayNamestring      `json:"display_name"`WorkspaceAgentIDstring      `json:"workspace_agent_id"`WorkspaceAgentNamestring      `json:"workspace_agent_name"`}

type AgentStatsReportRequest struct{}

type AgentStatsReportResponse struct {NumConnsint64 `json:"num_comms"`// RxBytes is the number of received bytes.RxBytesint64 `json:"rx_bytes"`// TxBytes is the number of transmitted bytes.TxBytesint64 `json:"tx_bytes"`}

type AgentSubsystemstring

func (AgentSubsystem)Valid¶

func (sAgentSubsystem) Valid()bool

type AppHostResponse struct {// Host is the externally accessible URL for the Coder instance.Hoststring `json:"host"`}

type AppearanceConfig struct {ApplicationNamestring `json:"application_name"`LogoURLstring `json:"logo_url"`DocsURLstring `json:"docs_url"`// Deprecated: ServiceBanner has been replaced by AnnouncementBanners.ServiceBannerBannerConfig   `json:"service_banner"`AnnouncementBanners []BannerConfig `json:"announcement_banners"`SupportLinks        []LinkConfig   `json:"support_links,omitempty"`}

type ArchiveTemplateVersionsRequest struct {// By default, only failed versions are archived. Set this to true// to archive all unused versions regardless of job status.Allbool `json:"all"`}

type ArchiveTemplateVersionsResponse struct {TemplateIDuuid.UUID   `json:"template_id" format:"uuid"`ArchivedIDs []uuid.UUID `json:"archived_ids"`}

type AssignableRoles struct {Role       `table:"r,recursive_inline"`Assignablebool `json:"assignable" table:"assignable"`// BuiltIn roles are immutableBuiltInbool `json:"built_in" table:"built_in"`}

type AuditActionstring

func (AuditAction)Friendly¶

func (aAuditAction) Friendly()string

type AuditDiff map[string]AuditDiffField

type AuditDiffField struct {Oldany  `json:"old,omitempty"`Newany  `json:"new,omitempty"`Secretbool `json:"secret"`}

type AuditLog struct {IDuuid.UUID    `json:"id" format:"uuid"`RequestIDuuid.UUID    `json:"request_id" format:"uuid"`Timetime.Time    `json:"time" format:"date-time"`IPnetip.Addr   `json:"ip"`UserAgentstring       `json:"user_agent"`ResourceTypeResourceType `json:"resource_type"`ResourceIDuuid.UUID    `json:"resource_id" format:"uuid"`// ResourceTarget is the name of the resource.ResourceTargetstring          `json:"resource_target"`ResourceIconstring          `json:"resource_icon"`ActionAuditAction     `json:"action"`DiffAuditDiff       `json:"diff"`StatusCodeint32           `json:"status_code"`AdditionalFieldsjson.RawMessage `json:"additional_fields" swaggertype:"object"`Descriptionstring          `json:"description"`ResourceLinkstring          `json:"resource_link"`IsDeletedbool            `json:"is_deleted"`// Deprecated: Use 'organization.id' instead.OrganizationIDuuid.UUID `json:"organization_id" format:"uuid"`Organization *MinimalOrganization `json:"organization,omitempty"`User *User `json:"user"`}

type AuditLogResponse struct {AuditLogs []AuditLog `json:"audit_logs"`Countint64      `json:"count"`}

type AuditLogsRequest struct {SearchQuerystring `json:"q,omitempty"`Pagination}

type AuthMethod struct {Enabledbool `json:"enabled"`}

type AuthMethods struct {TermsOfServiceURLstring           `json:"terms_of_service_url,omitempty"`PasswordAuthMethod       `json:"password"`GithubGithubAuthMethod `json:"github"`OIDCOIDCAuthMethod   `json:"oidc"`}

type AuthorizationCheck struct {// Object can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product.// When defining an object, use the most specific language when possible to// produce the smallest set. Meaning to set as many fields on 'Object' as// you can. Example, if you want to check if you can update all workspaces// owned by 'me', try to also add an 'OrganizationID' to the settings.// Omitting the 'OrganizationID' could produce the incorrect value, as// workspaces have both `user` and `organization` owners.ObjectAuthorizationObject `json:"object"`ActionRBACAction          `json:"action" enums:"create,read,update,delete"`}

type AuthorizationObject struct {// ResourceType is the name of the resource.// `./coderd/rbac/object.go` has the list of valid resource types.ResourceTypeRBACResource `json:"resource_type"`// OwnerID (optional) adds the set constraint to all resources owned by a given user.OwnerIDstring `json:"owner_id,omitempty"`// OrganizationID (optional) adds the set constraint to all resources owned by a given organization.OrganizationIDstring `json:"organization_id,omitempty"`// ResourceID (optional) reduces the set to a singular resource. This assigns// a resource ID to the resource type, eg: a single workspace.// The rbac library will not fetch the resource from the database, so if you// are using this option, you should also set the owner ID and organization ID// if possible. Be as specific as possible using all the fields relevant.ResourceIDstring `json:"resource_id,omitempty"`// AnyOrgOwner (optional) will disregard the org_owner when checking for permissions.// This cannot be set to true if the OrganizationID is set.AnyOrgOwnerbool `json:"any_org,omitempty"`}

type AuthorizationRequest struct {// Checks is a map keyed with an arbitrary string to a permission check.// The key can be any string that is helpful to the caller, and allows// multiple permission checks to be run in a single request.// The key ensures that each permission check has the same key in the// response.Checks map[string]AuthorizationCheck `json:"checks"`}

type AuthorizationResponse map[string]bool

type AutomaticUpdatesstring

type AvailableExperiments struct {Safe []Experiment `json:"safe"`}

type BannerConfig struct {Enabledbool   `json:"enabled"`Messagestring `json:"message,omitempty"`BackgroundColorstring `json:"background_color,omitempty"`}

type BuildInfoResponse struct {// ExternalURL references the current Coder version.// For production builds, this will link directly to a release. For development builds, this will link to a commit.ExternalURLstring `json:"external_url"`// Version returns the semantic version of the build.Versionstring `json:"version"`// DashboardURL is the URL to hit the deployment's dashboard.// For external workspace proxies, this is the coderd they are connected// to.DashboardURLstring `json:"dashboard_url"`// Telemetry is a boolean that indicates whether telemetry is enabled.Telemetrybool `json:"telemetry"`WorkspaceProxybool `json:"workspace_proxy"`// AgentAPIVersion is the current version of the Agent API (back versions// MAY still be supported).AgentAPIVersionstring `json:"agent_api_version"`// ProvisionerAPIVersion is the current version of the Provisioner APIProvisionerAPIVersionstring `json:"provisioner_api_version"`// UpgradeMessage is the message displayed to users when an outdated client// is detected.UpgradeMessagestring `json:"upgrade_message"`// DeploymentID is the unique identifier for this deployment.DeploymentIDstring `json:"deployment_id"`// WebPushPublicKey is the public key for push notifications via Web Push.WebPushPublicKeystring `json:"webpush_public_key,omitempty"`}

func (BuildInfoResponse)CanonicalVersion¶

func (bBuildInfoResponse) CanonicalVersion()string

CanonicalVersion trims build information from the version.E.g. 'v0.7.4-devel+11573034' -> 'v0.7.4'.

type BuildReasonstring

type ChangePasswordWithOneTimePasscodeRequest struct {Emailstring `json:"email" validate:"required,email" format:"email"`Passwordstring `json:"password" validate:"required"`OneTimePasscodestring `json:"one_time_passcode" validate:"required"`}

type Chat struct {IDuuid.UUID `json:"id" format:"uuid"`CreatedAttime.Time `json:"created_at" format:"date-time"`UpdatedAttime.Time `json:"updated_at" format:"date-time"`Titlestring    `json:"title"`}

type ChatMessage = aisdk.Message

type Client struct {HTTPClient *http.ClientURL        *url.URL// SessionTokenHeader is an optional custom header to use for setting tokens. By// default 'Coder-Session-Token' is used.SessionTokenHeaderstring// PlainLogger may be set to log HTTP traffic in a human-readable form.// It uses the LogBodies option.PlainLoggerio.Writer// Trace can be enabled to propagate tracing spans to the Coder API.// This is useful for tracking a request end-to-end.Tracebool// DisableDirectConnections forces any connections to workspaces to go// through DERP, regardless of the BlockEndpoints setting on each// connection.DisableDirectConnectionsbool// contains filtered or unexported fields}

funcNew¶

func New(serverURL *url.URL) *Client

New creates a Coder client for the provided URL.

func (*Client)APIKeyByID¶

func (c *Client) APIKeyByID(ctxcontext.Context, userIDstring, idstring) (*APIKey,error)

APIKeyByID returns the api key by id.

func (*Client)APIKeyByName¶

func (c *Client) APIKeyByName(ctxcontext.Context, userIDstring, namestring) (*APIKey,error)

APIKeyByName returns the api key by name.

func (*Client)AddLicense¶

func (c *Client) AddLicense(ctxcontext.Context, rAddLicenseRequest) (License,error)

func (*Client)AppHost¶

func (c *Client) AppHost(ctxcontext.Context) (AppHostResponse,error)

AppHost returns the site-wide application wildcard hostnamee.g. "*--apps.coder.com". Apps are accessible at:"<app-name>--<agent-name>--<workspace-name>--<username><app-host>", e.g."my-app--agent--workspace--username--apps.coder.com".

If the app host is not set, the response will contain an empty string.

func (*Client)Appearance¶

func (c *Client) Appearance(ctxcontext.Context) (AppearanceConfig,error)

Appearance returns the configuration that modifies the visualdisplay of the dashboard.

func (*Client)ArchiveTemplateVersions¶added inv2.3.0

func (c *Client) ArchiveTemplateVersions(ctxcontext.Context, templateuuid.UUID, allbool) (ArchiveTemplateVersionsResponse,error)

func (*Client)AuditLogs¶

func (c *Client) AuditLogs(ctxcontext.Context, reqAuditLogsRequest) (AuditLogResponse,error)

AuditLogs retrieves audit logs from the given page.

func (*Client)AuthCheck¶

func (c *Client) AuthCheck(ctxcontext.Context, reqAuthorizationRequest) (AuthorizationResponse,error)

AuthCheck allows the authenticated user to check if they have the given permissionsto a set of resources.

func (*Client)AuthMethods¶

func (c *Client) AuthMethods(ctxcontext.Context) (AuthMethods,error)

AuthMethods returns types of authentication available to the user.

func (*Client)BuildInfo¶

func (c *Client) BuildInfo(ctxcontext.Context) (BuildInfoResponse,error)

BuildInfo returns build information for this instance of Coder.

func (*Client)CancelTemplateVersion¶

func (c *Client) CancelTemplateVersion(ctxcontext.Context, versionuuid.UUID)error

CancelTemplateVersion marks a template version job as canceled.

func (*Client)CancelTemplateVersionDryRun¶

func (c *Client) CancelTemplateVersionDryRun(ctxcontext.Context, version, jobuuid.UUID)error

CancelTemplateVersionDryRun marks a template version dry-run job as canceled.

func (*Client)CancelWorkspaceBuild¶

func (c *Client) CancelWorkspaceBuild(ctxcontext.Context, iduuid.UUID)error

CancelWorkspaceBuild marks a workspace build job as canceled.

func (*Client)ChangePasswordWithOneTimePasscode¶added inv2.17.0

func (c *Client) ChangePasswordWithOneTimePasscode(ctxcontext.Context, reqChangePasswordWithOneTimePasscodeRequest)error

func (*Client)Chat¶added inv2.23.0

func (c *Client) Chat(ctxcontext.Context, iduuid.UUID) (Chat,error)

Chat returns a chat by ID.

func (*Client)ChatMessages¶added inv2.23.0

func (c *Client) ChatMessages(ctxcontext.Context, iduuid.UUID) ([]ChatMessage,error)

ChatMessages returns the messages of a chat.

func (*Client)ConvertLoginType¶

func (c *Client) ConvertLoginType(ctxcontext.Context, reqConvertLoginRequest) (OAuthConversionResponse,error)

ConvertLoginType will send a request to convert the user from passwordbased authentication to oauth based. The response has the oauth state codeto use in the oauth flow.

func (*Client)ConvertUserLoginType¶added inv2.23.0

func (c *Client) ConvertUserLoginType(ctxcontext.Context, userstring, reqConvertLoginRequest) (OAuthConversionResponse,error)

ConvertUserLoginType will send a request to convert the user from passwordbased authentication to oauth based. The response has the oauth state codeto use in the oauth flow.

func (*Client)CreateAPIKey¶

func (c *Client) CreateAPIKey(ctxcontext.Context, userstring) (GenerateAPIKeyResponse,error)

CreateAPIKey generates an API key for the user ID provided.CreateToken should be used over CreateAPIKey. CreateToken allows bettertracking of the token's usage and allows for custom expiration.Only use CreateAPIKey if you want to emulate the session created fora browser like login.

func (*Client)CreateChat¶added inv2.23.0

func (c *Client) CreateChat(ctxcontext.Context) (Chat,error)

CreateChat creates a new chat.

func (*Client)CreateChatMessage¶added inv2.23.0

func (c *Client) CreateChatMessage(ctxcontext.Context, iduuid.UUID, reqCreateChatMessageRequest) (<-chan aisdk.DataStreamPart,error)

CreateChatMessage creates a new chat message and streams the response.If the provided message has a conflicting ID with an existing message,it will be overwritten.

func (*Client)CreateFirstUser¶

func (c *Client) CreateFirstUser(ctxcontext.Context, reqCreateFirstUserRequest) (CreateFirstUserResponse,error)

CreateFirstUser attempts to create the first user on a Coder deployment.This initial user has superadmin privileges. If >0 users exist, this request will fail.

func (*Client)CreateGroup¶

func (c *Client) CreateGroup(ctxcontext.Context, orgIDuuid.UUID, reqCreateGroupRequest) (Group,error)

func (*Client)CreateOrganization¶

func (c *Client) CreateOrganization(ctxcontext.Context, reqCreateOrganizationRequest) (Organization,error)

CreateOrganization creates an organization and adds the user making the request as an owner.

func (*Client)CreateOrganizationRole¶added inv2.15.0

func (c *Client) CreateOrganizationRole(ctxcontext.Context, roleRole) (Role,error)

CreateOrganizationRole will create a custom organization role

func (*Client)CreateProvisionerKey¶added inv2.14.0

func (c *Client) CreateProvisionerKey(ctxcontext.Context, organizationIDuuid.UUID, reqCreateProvisionerKeyRequest) (CreateProvisionerKeyResponse,error)

CreateProvisionerKey creates a new provisioner key for an organization.

func (*Client)CreateTemplate¶

func (c *Client) CreateTemplate(ctxcontext.Context, organizationIDuuid.UUID, requestCreateTemplateRequest) (Template,error)

CreateTemplate creates a new template inside an organization.

func (*Client)CreateTemplateVersion¶

func (c *Client) CreateTemplateVersion(ctxcontext.Context, organizationIDuuid.UUID, reqCreateTemplateVersionRequest) (TemplateVersion,error)

CreateTemplateVersion processes source-code and optionally associates the version with a template.Executing without a template is useful for validating source-code.

func (*Client)CreateTemplateVersionDryRun¶

func (c *Client) CreateTemplateVersionDryRun(ctxcontext.Context, versionuuid.UUID, reqCreateTemplateVersionDryRunRequest) (ProvisionerJob,error)

CreateTemplateVersionDryRun begins a dry-run provisioner job against thegiven template version with the given parameter values.

func (*Client)CreateTestAuditLog¶

func (c *Client) CreateTestAuditLog(ctxcontext.Context, reqCreateTestAuditLogRequest)error

CreateTestAuditLog creates a fake audit log. Only owners of the organizationcan perform this action. It's used for testing purposes.

func (*Client)CreateToken¶

func (c *Client) CreateToken(ctxcontext.Context, userIDstring, reqCreateTokenRequest) (GenerateAPIKeyResponse,error)

CreateToken generates an API key for the user ID provided withcustom expiration. These tokens can be used for long-lived access,like for use with CI.

func (*Client)CreateUser¶

func (c *Client) CreateUser(ctxcontext.Context, reqCreateUserRequest) (User,error)

CreateUserDeprecated: Use CreateUserWithOrgs instead. This will be removed.TODO: When removing, we should rename CreateUserWithOrgs -> CreateUserwith an alias of CreateUserWithOrgs.

func (*Client)CreateUserWithOrgs¶added inv2.15.0

func (c *Client) CreateUserWithOrgs(ctxcontext.Context, reqCreateUserRequestWithOrgs) (User,error)

CreateUserWithOrgs creates a new user.

func (*Client)CreateUserWorkspace¶added inv2.14.0

func (c *Client) CreateUserWorkspace(ctxcontext.Context, userstring, requestCreateWorkspaceRequest) (Workspace,error)

CreateUserWorkspace creates a new workspace for the template specified.

func (*Client)CreateWorkspaceBuild¶

func (c *Client) CreateWorkspaceBuild(ctxcontext.Context, workspaceuuid.UUID, requestCreateWorkspaceBuildRequest) (WorkspaceBuild,error)

CreateWorkspaceBuild queues a new build to occur for a workspace.

func (*Client)CreateWorkspaceProxy¶

func (c *Client) CreateWorkspaceProxy(ctxcontext.Context, reqCreateWorkspaceProxyRequest) (UpdateWorkspaceProxyResponse,error)

func (*Client)DeleteAPIKey¶

func (c *Client) DeleteAPIKey(ctxcontext.Context, userIDstring, idstring)error

DeleteAPIKey deletes API key by id.

func (*Client)DeleteChat¶added inv2.23.0

func (c *Client) DeleteChat(ctxcontext.Context, iduuid.UUID)error

func (*Client)DeleteGroup¶

func (c *Client) DeleteGroup(ctxcontext.Context, groupuuid.UUID)error

func (*Client)DeleteLicense¶

func (c *Client) DeleteLicense(ctxcontext.Context, idint32)error

func (*Client)DeleteOAuth2ProviderApp¶added inv2.6.0

func (c *Client) DeleteOAuth2ProviderApp(ctxcontext.Context, iduuid.UUID)error

DeleteOAuth2ProviderApp deletes an application, also invalidating any tokensthat were generated from it.

func (*Client)DeleteOAuth2ProviderAppSecret¶added inv2.6.0

func (c *Client) DeleteOAuth2ProviderAppSecret(ctxcontext.Context, appIDuuid.UUID, secretIDuuid.UUID)error

DeleteOAuth2ProviderAppSecret deletes a secret from an OAuth2 application,also invalidating any tokens that generated from it.

func (*Client)DeleteOrganization¶added inv2.12.0

func (c *Client) DeleteOrganization(ctxcontext.Context, orgIDstring)error

DeleteOrganization will remove the corresponding organization from the deployment, based onthe UUID/name provided as `orgID`.

func (*Client)DeleteOrganizationMember¶added inv2.13.0

func (c *Client) DeleteOrganizationMember(ctxcontext.Context, organizationIDuuid.UUID, userstring)error

DeleteOrganizationMember removes a user from an organization

func (*Client)DeleteOrganizationRole¶added inv2.15.0

func (c *Client) DeleteOrganizationRole(ctxcontext.Context, organizationIDuuid.UUID, roleNamestring)error

DeleteOrganizationRole will delete a custom organization role

func (*Client)DeleteProvisionerKey¶added inv2.14.0

func (c *Client) DeleteProvisionerKey(ctxcontext.Context, organizationIDuuid.UUID, namestring)error

DeleteProvisionerKey deletes a provisioner key.

func (*Client)DeleteTemplate¶

func (c *Client) DeleteTemplate(ctxcontext.Context, templateuuid.UUID)error

func (*Client)DeleteUser¶

func (c *Client) DeleteUser(ctxcontext.Context, iduuid.UUID)error

DeleteUser deletes a user.

func (*Client)DeleteWebpushSubscription¶added inv2.21.0

func (c *Client) DeleteWebpushSubscription(ctxcontext.Context, userstring, reqDeleteWebpushSubscription)error

DeleteWebpushSubscription deletes a push notification subscription for a given user.Think of this as an unsubscribe, but for a specific push notification subscription.

func (*Client)DeleteWorkspaceAgentPortShare¶added inv2.9.0

func (c *Client) DeleteWorkspaceAgentPortShare(ctxcontext.Context, workspaceIDuuid.UUID, reqDeleteWorkspaceAgentPortShareRequest)error

func (*Client)DeleteWorkspaceProxyByID¶

func (c *Client) DeleteWorkspaceProxyByID(ctxcontext.Context, iduuid.UUID)error

func (*Client)DeleteWorkspaceProxyByName¶

func (c *Client) DeleteWorkspaceProxyByName(ctxcontext.Context, namestring)error

func (*Client)DeletedWorkspace¶

func (c *Client) DeletedWorkspace(ctxcontext.Context, iduuid.UUID) (Workspace,error)

DeletedWorkspace returns a single workspace that was deleted.

func (*Client)DeploymentConfig¶

func (c *Client) DeploymentConfig(ctxcontext.Context) (*DeploymentConfig,error)

DeploymentConfig returns the deployment config for the coder server.

func (*Client)DeploymentDAUs¶

func (c *Client) DeploymentDAUs(ctxcontext.Context, tzOffsetint) (*DAUsResponse,error)

DeploymentDAUs requires a tzOffset in hours. Use 0 for UTC, and TimezoneOffsetHour(time.Local) for thelocal timezone.

func (*Client)DeploymentDAUsLocalTZ¶

func (c *Client) DeploymentDAUsLocalTZ(ctxcontext.Context) (*DAUsResponse,error)

func (*Client)DeploymentStats¶

func (c *Client) DeploymentStats(ctxcontext.Context) (DeploymentStats,error)

func (*Client)Dial¶added inv2.22.0

func (c *Client) Dial(ctxcontext.Context, pathstring, opts *websocket.DialOptions) (*websocket.Conn,error)

func (*Client)Download¶

func (c *Client) Download(ctxcontext.Context, iduuid.UUID) ([]byte,string,error)

Download fetches a file by uploaded hash.

func (*Client)DownloadWithFormat¶added inv2.8.0

func (c *Client) DownloadWithFormat(ctxcontext.Context, iduuid.UUID, formatstring) ([]byte,string,error)

Download fetches a file by uploaded hash, but it forces format conversion.

func (*Client)Entitlements¶

func (c *Client) Entitlements(ctxcontext.Context) (Entitlements,error)

func (*Client)Experiments¶

func (c *Client) Experiments(ctxcontext.Context) (Experiments,error)

func (*Client)ExternalAuthByID¶added inv2.2.1

func (c *Client) ExternalAuthByID(ctxcontext.Context, providerstring) (ExternalAuth,error)

ExternalAuthByID returns the external auth for the given provider by ID.

func (*Client)ExternalAuthDeviceByID¶added inv2.2.1

func (c *Client) ExternalAuthDeviceByID(ctxcontext.Context, providerstring) (ExternalAuthDevice,error)

func (*Client)ExternalAuthDeviceExchange¶added inv2.2.1

func (c *Client) ExternalAuthDeviceExchange(ctxcontext.Context, providerstring, reqExternalAuthDeviceExchange)error

ExchangeGitAuth exchanges a device code for an external auth token.

func (*Client)FavoriteWorkspace¶added inv2.8.0

func (c *Client) FavoriteWorkspace(ctxcontext.Context, workspaceIDuuid.UUID)error

func (*Client)GetAvailableIDPSyncFields¶added inv2.18.0

func (c *Client) GetAvailableIDPSyncFields(ctxcontext.Context) ([]string,error)

func (*Client)GetIDPSyncFieldValues¶added inv2.19.0

func (c *Client) GetIDPSyncFieldValues(ctxcontext.Context, claimFieldstring) ([]string,error)

func (*Client)GetNotificationDispatchMethods¶added inv2.15.0

func (c *Client) GetNotificationDispatchMethods(ctxcontext.Context) (NotificationMethodsResponse,error)

GetNotificationDispatchMethods the available and default notification dispatch methods.

func (*Client)GetNotificationsSettings¶added inv2.14.0

func (c *Client) GetNotificationsSettings(ctxcontext.Context) (NotificationsSettings,error)

GetNotificationsSettings retrieves the notifications settings, which currently just describes whether allnotifications are paused from sending.

func (*Client)GetOrganizationAvailableIDPSyncFields¶added inv2.18.0

func (c *Client) GetOrganizationAvailableIDPSyncFields(ctxcontext.Context, orgIDstring) ([]string,error)

func (*Client)GetOrganizationIDPSyncFieldValues¶added inv2.19.0

func (c *Client) GetOrganizationIDPSyncFieldValues(ctxcontext.Context, orgIDstring, claimFieldstring) ([]string,error)

func (*Client)GetProvisionerKey¶added inv2.18.0

func (c *Client) GetProvisionerKey(ctxcontext.Context, pkstring) (ProvisionerKey,error)

GetProvisionerKey returns the provisioner key.

func (*Client)GetSystemNotificationTemplates¶added inv2.15.0

func (c *Client) GetSystemNotificationTemplates(ctxcontext.Context) ([]NotificationTemplate,error)

GetSystemNotificationTemplates retrieves all notification templates pertaining to internal system events.

func (*Client)GetTokenConfig¶

func (c *Client) GetTokenConfig(ctxcontext.Context, userIDstring) (TokenConfig,error)

GetTokenConfig returns deployment options related to token management

func (*Client)GetUserAppearanceSettings¶added inv2.22.0

func (c *Client) GetUserAppearanceSettings(ctxcontext.Context, userstring) (UserAppearanceSettings,error)

GetUserAppearanceSettings fetches the appearance settings for a user.

func (*Client)GetUserNotificationPreferences¶added inv2.15.0

func (c *Client) GetUserNotificationPreferences(ctxcontext.Context, userIDuuid.UUID) ([]NotificationPreference,error)

GetUserNotificationPreferences retrieves notification preferences for a given user.

func (*Client)GetUserStatusCounts¶added inv2.19.0

func (c *Client) GetUserStatusCounts(ctxcontext.Context, reqGetUserStatusCountsRequest) (GetUserStatusCountsResponse,error)

func (*Client)GetWorkspaceAgentPortShares¶added inv2.9.0

func (c *Client) GetWorkspaceAgentPortShares(ctxcontext.Context, workspaceIDuuid.UUID) (WorkspaceAgentPortShares,error)

func (*Client)GitSSHKey¶

func (c *Client) GitSSHKey(ctxcontext.Context, userstring) (GitSSHKey,error)

GitSSHKey returns the user's git SSH public key.

func (*Client)Group¶

func (c *Client) Group(ctxcontext.Context, groupuuid.UUID) (Group,error)

func (*Client)GroupByOrgAndName¶

func (c *Client) GroupByOrgAndName(ctxcontext.Context, orgIDuuid.UUID, namestring) (Group,error)

func (*Client)GroupIDPSyncSettings¶added inv2.16.0

func (c *Client) GroupIDPSyncSettings(ctxcontext.Context, orgIDstring) (GroupSyncSettings,error)

func (*Client)Groups¶added inv2.15.0

func (c *Client) Groups(ctxcontext.Context, argsGroupArguments) ([]Group,error)

func (*Client)GroupsByOrganization¶

func (c *Client) GroupsByOrganization(ctxcontext.Context, orgIDuuid.UUID) ([]Group,error)

GroupsByOrganizationDeprecated: use Groups with GroupArguments instead.

func (*Client)HasFirstUser¶

func (c *Client) HasFirstUser(ctxcontext.Context) (bool,error)

HasFirstUser returns whether the first user has been created.

func (*Client)IssueReconnectingPTYSignedToken¶

func (c *Client) IssueReconnectingPTYSignedToken(ctxcontext.Context, reqIssueReconnectingPTYSignedTokenRequest) (IssueReconnectingPTYSignedTokenResponse,error)

func (*Client)LanguageModelConfig¶added inv2.23.0

func (c *Client) LanguageModelConfig(ctxcontext.Context) (LanguageModelConfig,error)

func (*Client)Licenses¶

func (c *Client) Licenses(ctxcontext.Context) ([]License,error)

func (*Client)ListChats¶added inv2.23.0

func (c *Client) ListChats(ctxcontext.Context) ([]Chat,error)

ListChats lists all chats.

func (*Client)ListExternalAuths¶added inv2.5.0

func (c *Client) ListExternalAuths(ctxcontext.Context) (ListUserExternalAuthResponse,error)

ListExternalAuths returns the available external auth providers and the user'sauthenticated links if they exist.

func (*Client)ListInboxNotifications¶added inv2.21.0

func (c *Client) ListInboxNotifications(ctxcontext.Context, reqListInboxNotificationsRequest) (ListInboxNotificationsResponse,error)

func (*Client)ListOrganizationRoles¶

func (c *Client) ListOrganizationRoles(ctxcontext.Context, orguuid.UUID) ([]AssignableRoles,error)

ListOrganizationRoles lists all assignable roles for a given organization.

func (*Client)ListProvisionerKeyDaemons¶added inv2.16.0

func (c *Client) ListProvisionerKeyDaemons(ctxcontext.Context, organizationIDuuid.UUID) ([]ProvisionerKeyDaemons,error)

ListProvisionerKeyDaemons lists all provisioner keys with their associated daemons for an organization.

func (*Client)ListProvisionerKeys¶added inv2.14.0

func (c *Client) ListProvisionerKeys(ctxcontext.Context, organizationIDuuid.UUID) ([]ProvisionerKey,error)

ListProvisionerKeys lists all provisioner keys for an organization.

func (*Client)ListSiteRoles¶

func (c *Client) ListSiteRoles(ctxcontext.Context) ([]AssignableRoles,error)

ListSiteRoles lists all assignable site wide roles.

func (*Client)LogBodies¶

func (c *Client) LogBodies()bool

LogBodies returns whether requests and response bodies are logged.

func (*Client)Logger¶

func (c *Client) Logger()slog.Logger

Logger returns the logger for the client.

func (*Client)LoginWithPassword¶

func (c *Client) LoginWithPassword(ctxcontext.Context, reqLoginWithPasswordRequest) (LoginWithPasswordResponse,error)

LoginWithPassword creates a session token authenticating with an email and password.Call `SetSessionToken()` to apply the newly acquired token to the client.

func (*Client)Logout¶

func (c *Client) Logout(ctxcontext.Context)error

Logout calls the /logout APICall `ClearSessionToken()` to clear the session token of the client.

func (*Client)MarkAllInboxNotificationsAsRead¶added inv2.21.0

func (c *Client) MarkAllInboxNotificationsAsRead(ctxcontext.Context)error

func (*Client)OAuth2ProviderApp¶added inv2.6.0

func (c *Client) OAuth2ProviderApp(ctxcontext.Context, iduuid.UUID) (OAuth2ProviderApp,error)

OAuth2ProviderApp returns an application configured to authenticate usingCoder as an OAuth2 provider.

func (*Client)OAuth2ProviderAppSecrets¶added inv2.6.0

func (c *Client) OAuth2ProviderAppSecrets(ctxcontext.Context, appIDuuid.UUID) ([]OAuth2ProviderAppSecret,error)

OAuth2ProviderAppSecrets returns the truncated secrets for an OAuth2application.

func (*Client)OAuth2ProviderApps¶added inv2.6.0

func (c *Client) OAuth2ProviderApps(ctxcontext.Context, filterOAuth2ProviderAppFilter) ([]OAuth2ProviderApp,error)

OAuth2ProviderApps returns the applications configured to authenticate usingCoder as an OAuth2 provider.

func (*Client)Organization¶

func (c *Client) Organization(ctxcontext.Context, iduuid.UUID) (Organization,error)

func (*Client)OrganizationByName¶

func (c *Client) OrganizationByName(ctxcontext.Context, namestring) (Organization,error)

func (*Client)OrganizationByUserAndName¶added inv2.9.0

func (c *Client) OrganizationByUserAndName(ctxcontext.Context, userstring, namestring) (Organization,error)

func (*Client)OrganizationIDPSyncSettings¶added inv2.18.0

func (c *Client) OrganizationIDPSyncSettings(ctxcontext.Context) (OrganizationSyncSettings,error)

func (*Client)OrganizationMembers¶added inv2.13.0

func (c *Client) OrganizationMembers(ctxcontext.Context, organizationIDuuid.UUID) ([]OrganizationMemberWithUserData,error)

OrganizationMembers lists all members in an organization

func (*Client)OrganizationProvisionerDaemons¶added inv2.14.0

func (c *Client) OrganizationProvisionerDaemons(ctxcontext.Context, organizationIDuuid.UUID, opts *OrganizationProvisionerDaemonsOptions) ([]ProvisionerDaemon,error)

func (*Client)OrganizationProvisionerJob¶added inv2.19.0

func (c *Client) OrganizationProvisionerJob(ctxcontext.Context, organizationID, jobIDuuid.UUID) (jobProvisionerJob, errerror)

func (*Client)OrganizationProvisionerJobs¶added inv2.19.0

func (c *Client) OrganizationProvisionerJobs(ctxcontext.Context, organizationIDuuid.UUID, opts *OrganizationProvisionerJobsOptions) ([]ProvisionerJob,error)

func (*Client)Organizations¶added inv2.14.0

func (c *Client) Organizations(ctxcontext.Context) ([]Organization,error)

func (*Client)OrganizationsByUser¶

func (c *Client) OrganizationsByUser(ctxcontext.Context, userstring) ([]Organization,error)

OrganizationsByUser returns all organizations the user is a member of.

func (*Client)PatchGroup¶

func (c *Client) PatchGroup(ctxcontext.Context, groupuuid.UUID, reqPatchGroupRequest) (Group,error)

func (*Client)PatchGroupIDPSyncConfig¶added inv2.19.0

func (c *Client) PatchGroupIDPSyncConfig(ctxcontext.Context, orgIDstring, reqPatchGroupIDPSyncConfigRequest) (GroupSyncSettings,error)

func (*Client)PatchGroupIDPSyncMapping¶added inv2.19.0

func (c *Client) PatchGroupIDPSyncMapping(ctxcontext.Context, orgIDstring, reqPatchGroupIDPSyncMappingRequest) (GroupSyncSettings,error)

func (*Client)PatchGroupIDPSyncSettings¶added inv2.16.0

func (c *Client) PatchGroupIDPSyncSettings(ctxcontext.Context, orgIDstring, reqGroupSyncSettings) (GroupSyncSettings,error)

func (*Client)PatchOrganizationIDPSyncConfig¶added inv2.19.0

func (c *Client) PatchOrganizationIDPSyncConfig(ctxcontext.Context, reqPatchOrganizationIDPSyncConfigRequest) (OrganizationSyncSettings,error)

func (*Client)PatchOrganizationIDPSyncMapping¶added inv2.19.0

func (c *Client) PatchOrganizationIDPSyncMapping(ctxcontext.Context, reqPatchOrganizationIDPSyncMappingRequest) (OrganizationSyncSettings,error)

func (*Client)PatchOrganizationIDPSyncSettings¶added inv2.18.0

func (c *Client) PatchOrganizationIDPSyncSettings(ctxcontext.Context, reqOrganizationSyncSettings) (OrganizationSyncSettings,error)

func (*Client)PatchRoleIDPSyncConfig¶added inv2.19.0

func (c *Client) PatchRoleIDPSyncConfig(ctxcontext.Context, orgIDstring, reqPatchRoleIDPSyncConfigRequest) (RoleSyncSettings,error)

func (*Client)PatchRoleIDPSyncMapping¶added inv2.19.0

func (c *Client) PatchRoleIDPSyncMapping(ctxcontext.Context, orgIDstring, reqPatchRoleIDPSyncMappingRequest) (RoleSyncSettings,error)

func (*Client)PatchRoleIDPSyncSettings¶added inv2.16.0

func (c *Client) PatchRoleIDPSyncSettings(ctxcontext.Context, orgIDstring, reqRoleSyncSettings) (RoleSyncSettings,error)

func (*Client)PatchWorkspaceProxy¶

func (c *Client) PatchWorkspaceProxy(ctxcontext.Context, reqPatchWorkspaceProxy) (UpdateWorkspaceProxyResponse,error)

func (*Client)PostOAuth2ProviderApp¶added inv2.6.0

func (c *Client) PostOAuth2ProviderApp(ctxcontext.Context, appPostOAuth2ProviderAppRequest) (OAuth2ProviderApp,error)

PostOAuth2ProviderApp adds an application that can authenticate using Coderas an OAuth2 provider.

func (*Client)PostOAuth2ProviderAppSecret¶added inv2.6.0

func (c *Client) PostOAuth2ProviderAppSecret(ctxcontext.Context, appIDuuid.UUID) (OAuth2ProviderAppSecretFull,error)

PostOAuth2ProviderAppSecret creates a new secret for an OAuth2 application.This is the only time the full secret will be revealed.

func (*Client)PostOrganizationMember¶added inv2.13.0

func (c *Client) PostOrganizationMember(ctxcontext.Context, organizationIDuuid.UUID, userstring) (OrganizationMember,error)

PostOrganizationMember adds a user to an organization

func (*Client)PostTestNotification¶added inv2.20.0

func (c *Client) PostTestNotification(ctxcontext.Context)error

func (*Client)PostTestWebpushMessage¶added inv2.21.0

func (c *Client) PostTestWebpushMessage(ctxcontext.Context)error

func (*Client)PostWebpushSubscription¶added inv2.21.0

func (c *Client) PostWebpushSubscription(ctxcontext.Context, userstring, reqWebpushSubscription)error

PostWebpushSubscription creates a push notification subscription for a given user.

func (*Client)PostWorkspaceUsage¶added inv2.10.0

func (c *Client) PostWorkspaceUsage(ctxcontext.Context, iduuid.UUID)error

PostWorkspaceUsage marks the workspace as having been used recently.Deprecated: use PostWorkspaceUsageWithBody instead

func (*Client)PostWorkspaceUsageWithBody¶added inv2.13.0

func (c *Client) PostWorkspaceUsageWithBody(ctxcontext.Context, iduuid.UUID, reqPostWorkspaceUsageRequest)error

PostWorkspaceUsage marks the workspace as having been used recently and records an app stat.

func (*Client)PreviousTemplateVersion¶

func (c *Client) PreviousTemplateVersion(ctxcontext.Context, organizationuuid.UUID, templateName, versionNamestring) (TemplateVersion,error)

func (*Client)ProvisionerDaemons¶

func (c *Client) ProvisionerDaemons(ctxcontext.Context) ([]ProvisionerDaemon,error)

ProvisionerDaemons returns provisioner daemons available.

func (*Client)PutExtendWorkspace¶

func (c *Client) PutExtendWorkspace(ctxcontext.Context, iduuid.UUID, reqPutExtendWorkspaceRequest)error

PutExtendWorkspace updates the deadline for resources of the latest workspace build.

func (*Client)PutNotificationsSettings¶added inv2.14.0

func (c *Client) PutNotificationsSettings(ctxcontext.Context, settingsNotificationsSettings)error

PutNotificationsSettings modifies the notifications settings, which currently just controls whether allnotifications are paused from sending.

func (*Client)PutOAuth2ProviderApp¶added inv2.6.0

func (c *Client) PutOAuth2ProviderApp(ctxcontext.Context, iduuid.UUID, appPutOAuth2ProviderAppRequest) (OAuth2ProviderApp,error)

PutOAuth2ProviderApp updates an application that can authenticate using Coderas an OAuth2 provider.

func (*Client)RegenerateGitSSHKey¶

func (c *Client) RegenerateGitSSHKey(ctxcontext.Context, userstring) (GitSSHKey,error)

RegenerateGitSSHKey will create a new SSH key pair for the user and return it.

func (*Client)Regions¶

func (c *Client) Regions(ctxcontext.Context) ([]Region,error)

func (*Client)Replicas¶

func (c *Client) Replicas(ctxcontext.Context) ([]Replica,error)

Replicas fetches the list of replicas.

func (*Client)Request¶

func (c *Client) Request(ctxcontext.Context, method, pathstring, body interface{}, opts ...RequestOption) (*http.Response,error)

Request performs a HTTP request with the body provided. The caller isresponsible for closing the response body.

func (*Client)RequestOneTimePasscode¶added inv2.17.0

func (c *Client) RequestOneTimePasscode(ctxcontext.Context, reqRequestOneTimePasscodeRequest)error

func (*Client)ResolveAutostart¶added inv2.4.0

func (c *Client) ResolveAutostart(ctxcontext.Context, workspaceIDstring) (ResolveAutostartResponse,error)

func (*Client)RevokeOAuth2ProviderApp¶added inv2.9.0

func (c *Client) RevokeOAuth2ProviderApp(ctxcontext.Context, appIDuuid.UUID)error

RevokeOAuth2ProviderApp completely revokes an app's access for theauthenticated user.

func (*Client)RoleIDPSyncSettings¶added inv2.16.0

func (c *Client) RoleIDPSyncSettings(ctxcontext.Context, orgIDstring) (RoleSyncSettings,error)

func (*Client)SSHConfiguration¶

func (c *Client) SSHConfiguration(ctxcontext.Context) (SSHConfigResponse,error)

SSHConfiguration returns information about the SSH configuration for theCoder instance.

func (*Client)SafeExperiments¶added inv2.3.1

func (c *Client) SafeExperiments(ctxcontext.Context) (AvailableExperiments,error)

func (*Client)ServeProvisionerDaemon¶

func (c *Client) ServeProvisionerDaemon(ctxcontext.Context, reqServeProvisionerDaemonRequest) (proto.DRPCProvisionerDaemonClient,error)

ServeProvisionerDaemon returns the gRPC service for a provisioner daemonimplementation. The context is during dial, not during the lifetime of theclient. Client should be closed after use.

func (*Client)SessionToken¶

func (c *Client) SessionToken()string

SessionToken returns the currently set token for the client.

func (*Client)SetArchiveTemplateVersion¶added inv2.3.0

func (c *Client) SetArchiveTemplateVersion(ctxcontext.Context, templateVersionuuid.UUID, archivebool)error

func (*Client)SetLogBodies¶

func (c *Client) SetLogBodies(logBodiesbool)

SetLogBodies sets whether to log request and response bodies.

func (*Client)SetLogger¶

func (c *Client) SetLogger(loggerslog.Logger)

SetLogger sets the logger for the client.

func (*Client)SetSessionToken¶

func (c *Client) SetSessionToken(tokenstring)

SetSessionToken returns the currently set token for the client.

func (*Client)StarterTemplates¶added inv2.15.0

func (c *Client) StarterTemplates(ctxcontext.Context) ([]TemplateExample,error)

StarterTemplates lists example templates available in Coder.

func (*Client)Template¶

func (c *Client) Template(ctxcontext.Context, templateuuid.UUID) (Template,error)

Template returns a single template.

func (*Client)TemplateACL¶

func (c *Client) TemplateACL(ctxcontext.Context, templateIDuuid.UUID) (TemplateACL,error)

func (*Client)TemplateACLAvailable¶

func (c *Client) TemplateACLAvailable(ctxcontext.Context, templateIDuuid.UUID) (ACLAvailable,error)

TemplateACLAvailable returns available users + groups that can be assigned template perms

func (*Client)TemplateByName¶

func (c *Client) TemplateByName(ctxcontext.Context, organizationIDuuid.UUID, namestring) (Template,error)

TemplateByName finds a template inside the organization provided with a case-insensitive name.

func (*Client)TemplateDAUs¶

func (c *Client) TemplateDAUs(ctxcontext.Context, templateIDuuid.UUID, tzOffsetint) (*DAUsResponse,error)

TemplateDAUs requires a tzOffset in hours. Use 0 for UTC, and TimezoneOffsetHour(time.Local) for thelocal timezone.

func (*Client)TemplateDAUsLocalTZ¶

func (c *Client) TemplateDAUsLocalTZ(ctxcontext.Context, templateIDuuid.UUID) (*DAUsResponse,error)

func (*Client)TemplateInsights¶

func (c *Client) TemplateInsights(ctxcontext.Context, reqTemplateInsightsRequest) (TemplateInsightsResponse,error)

func (*Client)TemplateVersion¶

func (c *Client) TemplateVersion(ctxcontext.Context, iduuid.UUID) (TemplateVersion,error)

TemplateVersion returns a template version by ID.

func (*Client)TemplateVersionByName¶

func (c *Client) TemplateVersionByName(ctxcontext.Context, templateuuid.UUID, namestring) (TemplateVersion,error)

TemplateVersionByName returns a template version by it's friendly name.This is used for path-based routing. Like: /templates/example/versions/helloworld

func (*Client)TemplateVersionByOrganizationAndName¶

func (c *Client) TemplateVersionByOrganizationAndName(ctxcontext.Context, organizationIDuuid.UUID, templateName, versionNamestring) (TemplateVersion,error)

func (*Client)TemplateVersionDryRun¶

func (c *Client) TemplateVersionDryRun(ctxcontext.Context, version, jobuuid.UUID) (ProvisionerJob,error)

TemplateVersionDryRun returns the current state of a template version dry-runjob.

func (*Client)TemplateVersionDryRunLogsAfter¶

func (c *Client) TemplateVersionDryRunLogsAfter(ctxcontext.Context, version, jobuuid.UUID, afterint64) (<-chanProvisionerJobLog,io.Closer,error)

TemplateVersionDryRunLogsAfter streams logs for a template version dry-runthat occurred after a specific log ID.

func (*Client)TemplateVersionDryRunMatchedProvisioners¶added inv2.18.1

func (c *Client) TemplateVersionDryRunMatchedProvisioners(ctxcontext.Context, version, jobuuid.UUID) (MatchedProvisioners,error)

TemplateVersionDryRunMatchedProvisioners returns the matched provisioners for atemplate version dry-run job.

func (*Client)TemplateVersionDryRunResources¶

func (c *Client) TemplateVersionDryRunResources(ctxcontext.Context, version, jobuuid.UUID) ([]WorkspaceResource,error)

TemplateVersionDryRunResources returns the resources of a finished templateversion dry-run job.

func (*Client)TemplateVersionDynamicParameters¶added inv2.22.0

func (c *Client) TemplateVersionDynamicParameters(ctxcontext.Context, versionuuid.UUID) (*wsjson.Stream[DynamicParametersResponse,DynamicParametersRequest],error)

func (*Client)TemplateVersionExternalAuth¶added inv2.2.1

func (c *Client) TemplateVersionExternalAuth(ctxcontext.Context, versionuuid.UUID) ([]TemplateVersionExternalAuth,error)

TemplateVersionExternalAuth returns authentication providers for the requested template version.

func (*Client)TemplateVersionLogsAfter¶

func (c *Client) TemplateVersionLogsAfter(ctxcontext.Context, versionuuid.UUID, afterint64) (<-chanProvisionerJobLog,io.Closer,error)

TemplateVersionLogsAfter streams logs for a template version that occurred after a specific log ID.

func (*Client)TemplateVersionPresets¶added inv2.20.0

func (c *Client) TemplateVersionPresets(ctxcontext.Context, templateVersionIDuuid.UUID) ([]Preset,error)

TemplateVersionPresets returns the presets associated with a template version.

func (*Client)TemplateVersionResources¶

func (c *Client) TemplateVersionResources(ctxcontext.Context, versionuuid.UUID) ([]WorkspaceResource,error)

TemplateVersionResources returns resources a template version declares.

func (*Client)TemplateVersionRichParameters¶

func (c *Client) TemplateVersionRichParameters(ctxcontext.Context, versionuuid.UUID) ([]TemplateVersionParameter,error)

TemplateVersionParameters returns parameters a template version exposes.

func (*Client)TemplateVersionVariables¶

func (c *Client) TemplateVersionVariables(ctxcontext.Context, versionuuid.UUID) ([]TemplateVersionVariable,error)

TemplateVersionVariables returns resources a template version variables.

func (*Client)TemplateVersionsByTemplate¶

func (c *Client) TemplateVersionsByTemplate(ctxcontext.Context, reqTemplateVersionsByTemplateRequest) ([]TemplateVersion,error)

TemplateVersionsByTemplate lists versions associated with a template.

func (*Client)Templates¶added inv2.13.0

func (c *Client) Templates(ctxcontext.Context, filterTemplateFilter) ([]Template,error)

Templates lists all viewable templates

func (*Client)TemplatesByOrganization¶

func (c *Client) TemplatesByOrganization(ctxcontext.Context, organizationIDuuid.UUID) ([]Template,error)

TemplatesByOrganization lists all templates inside of an organization.

func (*Client)Tokens¶

func (c *Client) Tokens(ctxcontext.Context, userIDstring, filterTokensFilter) ([]APIKeyWithOwner,error)

Tokens list machine API keys.

func (*Client)UnfavoriteWorkspace¶added inv2.8.0

func (c *Client) UnfavoriteWorkspace(ctxcontext.Context, workspaceIDuuid.UUID)error

func (*Client)UnlinkExternalAuthByID¶added inv2.5.0

func (c *Client) UnlinkExternalAuthByID(ctxcontext.Context, providerstring)error

UnlinkExternalAuthByID deletes the external auth for the given provider by IDfor the user. This does not revoke the token from the IDP.

func (*Client)UpdateActiveTemplateVersion¶

func (c *Client) UpdateActiveTemplateVersion(ctxcontext.Context, templateuuid.UUID, reqUpdateActiveTemplateVersion)error

UpdateActiveTemplateVersion updates the active template version to the ID provided.The template version must be attached to the template.

func (*Client)UpdateAppearance¶

func (c *Client) UpdateAppearance(ctxcontext.Context, appearanceUpdateAppearanceConfig)error

func (*Client)UpdateCheck¶

func (c *Client) UpdateCheck(ctxcontext.Context) (UpdateCheckResponse,error)

UpdateCheck returns information about the latest release version ofCoder and whether or not the server is running the latest release.

func (*Client)UpdateInboxNotificationReadStatus¶added inv2.21.0

func (c *Client) UpdateInboxNotificationReadStatus(ctxcontext.Context, notifIDstring, reqUpdateInboxNotificationReadStatusRequest) (UpdateInboxNotificationReadStatusResponse,error)

func (*Client)UpdateNotificationTemplateMethod¶added inv2.15.0

func (c *Client) UpdateNotificationTemplateMethod(ctxcontext.Context, notificationTemplateIDuuid.UUID, methodstring)error

UpdateNotificationTemplateMethod modifies a notification template to use a specific notification method, overridingthe method set in the deployment configuration.

func (*Client)UpdateOrganization¶added inv2.12.0

func (c *Client) UpdateOrganization(ctxcontext.Context, orgIDstring, reqUpdateOrganizationRequest) (Organization,error)

UpdateOrganization will update information about the corresponding organization, based onthe UUID/name provided as `orgID`.

func (*Client)UpdateOrganizationMemberRoles¶

func (c *Client) UpdateOrganizationMemberRoles(ctxcontext.Context, organizationIDuuid.UUID, userstring, reqUpdateRoles) (OrganizationMember,error)

UpdateOrganizationMemberRoles grants the userID the specified roles in an org.Include ALL roles the user has.

func (*Client)UpdateOrganizationRole¶added inv2.15.0

func (c *Client) UpdateOrganizationRole(ctxcontext.Context, roleRole) (Role,error)

UpdateOrganizationRole will update an existing custom organization role

func (*Client)UpdateTemplateACL¶

func (c *Client) UpdateTemplateACL(ctxcontext.Context, templateIDuuid.UUID, reqUpdateTemplateACL)error

func (*Client)UpdateTemplateMeta¶

func (c *Client) UpdateTemplateMeta(ctxcontext.Context, templateIDuuid.UUID, reqUpdateTemplateMeta) (Template,error)

func (*Client)UpdateTemplateVersion¶

func (c *Client) UpdateTemplateVersion(ctxcontext.Context, versionIDuuid.UUID, reqPatchTemplateVersionRequest) (TemplateVersion,error)

func (*Client)UpdateUserAppearanceSettings¶added inv2.5.1

func (c *Client) UpdateUserAppearanceSettings(ctxcontext.Context, userstring, reqUpdateUserAppearanceSettingsRequest) (UserAppearanceSettings,error)

UpdateUserAppearanceSettings updates the appearance settings for a user.

func (*Client)UpdateUserNotificationPreferences¶added inv2.15.0

func (c *Client) UpdateUserNotificationPreferences(ctxcontext.Context, userIDuuid.UUID, reqUpdateUserNotificationPreferences) ([]NotificationPreference,error)

UpdateUserNotificationPreferences updates notification preferences for a given user.

func (*Client)UpdateUserPassword¶

func (c *Client) UpdateUserPassword(ctxcontext.Context, userstring, reqUpdateUserPasswordRequest)error

UpdateUserPassword updates a user password.It calls PUT /users/{user}/password

func (*Client)UpdateUserProfile¶

func (c *Client) UpdateUserProfile(ctxcontext.Context, userstring, reqUpdateUserProfileRequest) (User,error)

UpdateUserProfile updates the username of a user.

func (*Client)UpdateUserQuietHoursSchedule¶

func (c *Client) UpdateUserQuietHoursSchedule(ctxcontext.Context, userIdentstring, reqUpdateUserQuietHoursScheduleRequest) (UserQuietHoursScheduleResponse,error)

UpdateUserQuietHoursSchedule updates the quiet hours settings for the user.This endpoint only exists in enterprise editions.

func (*Client)UpdateUserRoles¶

func (c *Client) UpdateUserRoles(ctxcontext.Context, userstring, reqUpdateRoles) (User,error)

UpdateUserRoles grants the userID the specified roles.Include ALL roles the user has.

func (*Client)UpdateUserStatus¶

func (c *Client) UpdateUserStatus(ctxcontext.Context, userstring, statusUserStatus) (User,error)

UpdateUserStatus sets the user status to the given status

func (*Client)UpdateWorkspace¶

func (c *Client) UpdateWorkspace(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceRequest)error

func (*Client)UpdateWorkspaceAutomaticUpdates¶added inv2.3.0

func (c *Client) UpdateWorkspaceAutomaticUpdates(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceAutomaticUpdatesRequest)error

UpdateWorkspaceAutomaticUpdates sets the automatic updates setting for workspace by id.

func (*Client)UpdateWorkspaceAutostart¶

func (c *Client) UpdateWorkspaceAutostart(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceAutostartRequest)error

UpdateWorkspaceAutostart sets the autostart schedule for workspace by id.If the provided schedule is empty, autostart is disabled for the workspace.

func (*Client)UpdateWorkspaceDormancy¶added inv2.1.4

func (c *Client) UpdateWorkspaceDormancy(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceDormancy)error

UpdateWorkspaceDormancy sets a workspace as dormant if dormant=true and activates a dormant workspaceif dormant=false.

func (*Client)UpdateWorkspaceTTL¶

func (c *Client) UpdateWorkspaceTTL(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceTTLRequest)error

UpdateWorkspaceTTL sets the ttl for workspace by id.If the provided duration is nil, autostop is disabled for the workspace.

func (*Client)UpdateWorkspaceUsageContext¶added inv2.10.0

func (c *Client) UpdateWorkspaceUsageContext(ctxcontext.Context, workspaceIDuuid.UUID) func()

UpdateWorkspaceUsageContext periodically posts workspace usage for the workspacewith the given id in the background.The caller is responsible for calling the returned function to stop the backgroundprocess.Deprecated: use UpdateWorkspaceUsageContextWithBody instead

func (*Client)UpdateWorkspaceUsageWithBodyContext¶added inv2.13.0

func (c *Client) UpdateWorkspaceUsageWithBodyContext(ctxcontext.Context, workspaceIDuuid.UUID, reqPostWorkspaceUsageRequest) func()

UpdateWorkspaceUsageWithBodyContext periodically posts workspace usage for the workspacewith the given id and app name in the background.The caller is responsible for calling the returned function to stop the backgroundprocess.

func (*Client)Upload¶

func (c *Client) Upload(ctxcontext.Context, contentTypestring, rdio.Reader) (UploadResponse,error)

Upload uploads an arbitrary file with the content type provided.This is used to upload a source-code archive.

func (*Client)UpsertWorkspaceAgentPortShare¶added inv2.9.0

func (c *Client) UpsertWorkspaceAgentPortShare(ctxcontext.Context, workspaceIDuuid.UUID, reqUpsertWorkspaceAgentPortShareRequest) (WorkspaceAgentPortShare,error)

func (*Client)User¶

func (c *Client) User(ctxcontext.Context, userIdentstring) (User,error)

User returns a user for the ID/username provided.

func (*Client)UserActivityInsights¶added inv2.2.0

func (c *Client) UserActivityInsights(ctxcontext.Context, reqUserActivityInsightsRequest) (UserActivityInsightsResponse,error)

func (*Client)UserAutofillParameters¶added inv2.8.0

func (c *Client) UserAutofillParameters(ctxcontext.Context, userstring, templateIDuuid.UUID) ([]UserParameter,error)

UserAutofillParameters returns all recently used parameters for the given user.

func (*Client)UserLatencyInsights¶

func (c *Client) UserLatencyInsights(ctxcontext.Context, reqUserLatencyInsightsRequest) (UserLatencyInsightsResponse,error)

func (*Client)UserQuietHoursSchedule¶

func (c *Client) UserQuietHoursSchedule(ctxcontext.Context, userIdentstring) (UserQuietHoursScheduleResponse,error)

UserQuietHoursSchedule returns the quiet hours settings for the user. Thisendpoint only exists in enterprise editions.

func (*Client)UserRoles¶

func (c *Client) UserRoles(ctxcontext.Context, userstring) (UserRoles,error)

UserRoles returns all roles the user has

func (*Client)Users¶

func (c *Client) Users(ctxcontext.Context, reqUsersRequest) (GetUsersResponse,error)

Users returns all users according to the request parameters. If no parameters are set,the default behavior is to return all users in a single page.

func (*Client)ValidateUserPassword¶added inv2.18.0

func (c *Client) ValidateUserPassword(ctxcontext.Context, reqValidateUserPasswordRequest) (ValidateUserPasswordResponse,error)

ValidateUserPassword validates the complexity of a user password and that it is secured enough.

func (*Client)WatchWorkspace¶

func (c *Client) WatchWorkspace(ctxcontext.Context, iduuid.UUID) (<-chanWorkspace,error)

func (*Client)WatchWorkspaceAgentMetadata¶

func (c *Client) WatchWorkspaceAgentMetadata(ctxcontext.Context, iduuid.UUID) (<-chan []WorkspaceAgentMetadata, <-chanerror)

WatchWorkspaceAgentMetadata watches the metadata of a workspace agent.The returned channel will be closed when the context is canceled. Exactlyone error will be sent on the error channel. The metadata channel is never closed.

func (*Client)Workspace¶

func (c *Client) Workspace(ctxcontext.Context, iduuid.UUID) (Workspace,error)

Workspace returns a single workspace.

func (*Client)WorkspaceAgent¶

func (c *Client) WorkspaceAgent(ctxcontext.Context, iduuid.UUID) (WorkspaceAgent,error)

WorkspaceAgent returns an agent by ID.

func (*Client)WorkspaceAgentListContainers¶added inv2.20.0

func (c *Client) WorkspaceAgentListContainers(ctxcontext.Context, agentIDuuid.UUID, labels map[string]string) (WorkspaceAgentListContainersResponse,error)

WorkspaceAgentListContainers returns a list of containers that are currentlyrunning on a Docker daemon accessible to the workspace agent.

func (*Client)WorkspaceAgentListeningPorts¶

func (c *Client) WorkspaceAgentListeningPorts(ctxcontext.Context, agentIDuuid.UUID) (WorkspaceAgentListeningPortsResponse,error)

WorkspaceAgentListeningPorts returns a list of ports that are currently beinglistened on inside the workspace agent's network namespace.

func (*Client)WorkspaceAgentLogsAfter¶

func (c *Client) WorkspaceAgentLogsAfter(ctxcontext.Context, agentIDuuid.UUID, afterint64, followbool) (<-chan []WorkspaceAgentLog,io.Closer,error)

func (*Client)WorkspaceAgentRecreateDevcontainer¶added inv2.23.0

func (c *Client) WorkspaceAgentRecreateDevcontainer(ctxcontext.Context, agentIDuuid.UUID, containerIDOrNamestring) (Response,error)

WorkspaceAgentRecreateDevcontainer recreates the devcontainer with the given ID.

func (*Client)WorkspaceBuild¶

func (c *Client) WorkspaceBuild(ctxcontext.Context, iduuid.UUID) (WorkspaceBuild,error)

WorkspaceBuild returns a single workspace build for a workspace.If history is "", the latest version is returned.

func (*Client)WorkspaceBuildByUsernameAndWorkspaceNameAndBuildNumber¶

func (c *Client) WorkspaceBuildByUsernameAndWorkspaceNameAndBuildNumber(ctxcontext.Context, usernamestring, workspaceNamestring, buildNumberstring) (WorkspaceBuild,error)

func (*Client)WorkspaceBuildLogsAfter¶

func (c *Client) WorkspaceBuildLogsAfter(ctxcontext.Context, builduuid.UUID, afterint64) (<-chanProvisionerJobLog,io.Closer,error)

WorkspaceBuildLogsAfter streams logs for a workspace build that occurred after a specific log ID.

func (*Client)WorkspaceBuildParameters¶

func (c *Client) WorkspaceBuildParameters(ctxcontext.Context, builduuid.UUID) ([]WorkspaceBuildParameter,error)

func (*Client)WorkspaceBuildState¶

func (c *Client) WorkspaceBuildState(ctxcontext.Context, builduuid.UUID) ([]byte,error)

WorkspaceBuildState returns the provisioner state of the build.

func (*Client)WorkspaceBuildTimings¶added inv2.17.0

func (c *Client) WorkspaceBuildTimings(ctxcontext.Context, builduuid.UUID) (WorkspaceBuildTimings,error)

func (*Client)WorkspaceBuilds¶

func (c *Client) WorkspaceBuilds(ctxcontext.Context, reqWorkspaceBuildsRequest) ([]WorkspaceBuild,error)

func (*Client)WorkspaceByOwnerAndName¶

func (c *Client) WorkspaceByOwnerAndName(ctxcontext.Context, ownerstring, namestring, paramsWorkspaceOptions) (Workspace,error)

WorkspaceByOwnerAndName returns a workspace by the owner's UUID and the workspace's name.

func (*Client)WorkspaceProxies¶

func (c *Client) WorkspaceProxies(ctxcontext.Context) (RegionsResponse[WorkspaceProxy],error)

func (*Client)WorkspaceProxyByID¶

func (c *Client) WorkspaceProxyByID(ctxcontext.Context, iduuid.UUID) (WorkspaceProxy,error)

func (*Client)WorkspaceProxyByName¶

func (c *Client) WorkspaceProxyByName(ctxcontext.Context, namestring) (WorkspaceProxy,error)

func (*Client)WorkspaceQuota¶

func (c *Client) WorkspaceQuota(ctxcontext.Context, organizationIDstring, userIDstring) (WorkspaceQuota,error)

func (*Client)WorkspaceTimings¶added inv2.16.0

func (c *Client) WorkspaceTimings(ctxcontext.Context, iduuid.UUID) (WorkspaceBuildTimings,error)

func (*Client)Workspaces¶

func (c *Client) Workspaces(ctxcontext.Context, filterWorkspaceFilter) (WorkspacesResponse,error)

Workspaces returns all workspaces the authenticated user has access to.

type CoderDesktopTelemetry struct {DeviceIDstring `json:"device_id"`DeviceOSstring `json:"device_os"`CoderDesktopVersionstring `json:"coder_desktop_version"`}

func (*CoderDesktopTelemetry)FromHeader¶added inv2.21.0

func (t *CoderDesktopTelemetry) FromHeader(headerValuestring)error

FromHeader parses the desktop telemetry from the provided header value.Returns nil if the header is empty or if parsing fails.

func (*CoderDesktopTelemetry)IsEmpty¶added inv2.21.0

func (t *CoderDesktopTelemetry) IsEmpty()bool

IsEmpty returns true if all fields in the telemetry data are empty.

type ConnectionLatency struct {P50float64 `json:"p50" example:"31.312"`P95float64 `json:"p95" example:"119.832"`}

type ConvertLoginRequest struct {// ToType is the login type to convert to.ToTypeLoginType `json:"to_type" validate:"required"`Passwordstring    `json:"password" validate:"required"`}

type Country struct {Namestring `json:"name"`Flagstring `json:"flag"`}

type CreateChatMessageRequest struct {Modelstring      `json:"model"`MessageChatMessage `json:"message"`Thinkingbool        `json:"thinking"`}

type CreateFirstUserRequest struct {Emailstring                   `json:"email" validate:"required,email"`Usernamestring                   `json:"username" validate:"required,username"`Namestring                   `json:"name" validate:"user_real_name"`Passwordstring                   `json:"password" validate:"required"`Trialbool                     `json:"trial"`TrialInfoCreateFirstUserTrialInfo `json:"trial_info"`}

type CreateFirstUserResponse struct {UserIDuuid.UUID `json:"user_id" format:"uuid"`OrganizationIDuuid.UUID `json:"organization_id" format:"uuid"`}

type CreateFirstUserTrialInfo struct {FirstNamestring `json:"first_name"`LastNamestring `json:"last_name"`PhoneNumberstring `json:"phone_number"`JobTitlestring `json:"job_title"`CompanyNamestring `json:"company_name"`Countrystring `json:"country"`Developersstring `json:"developers"`}

type CreateGroupRequest struct {Namestring `json:"name" validate:"required,group_name"`DisplayNamestring `json:"display_name" validate:"omitempty,group_display_name"`AvatarURLstring `json:"avatar_url"`QuotaAllowanceint    `json:"quota_allowance"`}

type CreateOrganizationRequest struct {Namestring `json:"name" validate:"required,organization_name"`// DisplayName will default to the same value as `Name` if not provided.DisplayNamestring `json:"display_name,omitempty" validate:"omitempty,organization_display_name"`Descriptionstring `json:"description,omitempty"`Iconstring `json:"icon,omitempty"`}

type CreateProvisionerKeyRequest struct {Namestring            `json:"name"`Tags map[string]string `json:"tags"`}

type CreateProvisionerKeyResponse struct {Keystring `json:"key"`}

type CreateTemplateRequest struct {// Name is the name of the template.Namestring `json:"name" validate:"template_name,required"`// DisplayName is the displayed name of the template.DisplayNamestring `json:"display_name,omitempty" validate:"template_display_name"`// Description is a description of what the template contains. It must be// less than 128 bytes.Descriptionstring `json:"description,omitempty" validate:"lt=128"`// Icon is a relative path or external URL that specifies// an icon to be displayed in the dashboard.Iconstring `json:"icon,omitempty"`// VersionID is an in-progress or completed job to use as an initial version// of the template.//// This is required on creation to enable a user-flow of validating a// template works. There is no reason the data-model cannot support empty// templates, but it doesn't make sense for users.VersionIDuuid.UUID `json:"template_version_id" validate:"required" format:"uuid"`// DefaultTTLMillis allows optionally specifying the default TTL// for all workspaces created from this template.DefaultTTLMillis *int64 `json:"default_ttl_ms,omitempty"`// ActivityBumpMillis allows optionally specifying the activity bump// duration for all workspaces created from this template. Defaults to 1h// but can be set to 0 to disable activity bumping.ActivityBumpMillis *int64 `json:"activity_bump_ms,omitempty"`// AutostopRequirement allows optionally specifying the autostop requirement// for workspaces created from this template. This is an enterprise feature.AutostopRequirement *TemplateAutostopRequirement `json:"autostop_requirement,omitempty"`// AutostartRequirement allows optionally specifying the autostart allowed days// for workspaces created from this template. This is an enterprise feature.AutostartRequirement *TemplateAutostartRequirement `json:"autostart_requirement,omitempty"`// Allow users to cancel in-progress workspace jobs.// *bool as the default value is "true".AllowUserCancelWorkspaceJobs *bool `json:"allow_user_cancel_workspace_jobs"`// AllowUserAutostart allows users to set a schedule for autostarting their// workspace. By default this is true. This can only be disabled when using// an enterprise license.AllowUserAutostart *bool `json:"allow_user_autostart,omitempty"`// AllowUserAutostop allows users to set a custom workspace TTL to use in// place of the template's DefaultTTL field. By default this is true. If// false, the DefaultTTL will always be used. This can only be disabled when// using an enterprise license.AllowUserAutostop *bool `json:"allow_user_autostop,omitempty"`// FailureTTLMillis allows optionally specifying the max lifetime before Coder// stops all resources for failed workspaces created from this template.FailureTTLMillis *int64 `json:"failure_ttl_ms,omitempty"`// TimeTilDormantMillis allows optionally specifying the max lifetime before Coder// locks inactive workspaces created from this template.TimeTilDormantMillis *int64 `json:"dormant_ttl_ms,omitempty"`// TimeTilDormantAutoDeleteMillis allows optionally specifying the max lifetime before Coder// permanently deletes dormant workspaces created from this template.TimeTilDormantAutoDeleteMillis *int64 `json:"delete_ttl_ms,omitempty"`// DisableEveryoneGroupAccess allows optionally disabling the default// behavior of granting the 'everyone' group access to use the template.// If this is set to true, the template will not be available to all users,// and must be explicitly granted to users or groups in the permissions settings// of the template.DisableEveryoneGroupAccessbool `json:"disable_everyone_group_access"`// RequireActiveVersion mandates that workspaces are built with the active// template version.RequireActiveVersionbool `json:"require_active_version"`// MaxPortShareLevel allows optionally specifying the maximum port share level// for workspaces created from the template.MaxPortShareLevel *WorkspaceAgentPortShareLevel `json:"max_port_share_level"`}

type CreateTemplateVersionDryRunRequest struct {WorkspaceNamestring                    `json:"workspace_name"`RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values"`UserVariableValues  []VariableValue           `json:"user_variable_values,omitempty"`}

type CreateTemplateVersionRequest struct {Namestring `json:"name,omitempty" validate:"omitempty,template_version_name"`Messagestring `json:"message,omitempty" validate:"lt=1048577"`// TemplateID optionally associates a version with a template.TemplateIDuuid.UUID                `json:"template_id,omitempty" format:"uuid"`StorageMethodProvisionerStorageMethod `json:"storage_method" validate:"oneof=file,required" enums:"file"`FileIDuuid.UUID                `json:"file_id,omitempty" validate:"required_without=ExampleID" format:"uuid"`ExampleIDstring                   `json:"example_id,omitempty" validate:"required_without=FileID"`ProvisionerProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`ProvisionerTags map[string]string        `json:"tags"`UserVariableValues []VariableValue `json:"user_variable_values,omitempty"`}

type CreateTestAuditLogRequest struct {ActionAuditAction     `json:"action,omitempty" enums:"create,write,delete,start,stop"`ResourceTypeResourceType    `json:"resource_type,omitempty" enums:"template,template_version,user,workspace,workspace_build,git_ssh_key,auditable_group"`ResourceIDuuid.UUID       `json:"resource_id,omitempty" format:"uuid"`AdditionalFieldsjson.RawMessage `json:"additional_fields,omitempty"`Timetime.Time       `json:"time,omitempty" format:"date-time"`BuildReasonBuildReason     `json:"build_reason,omitempty" enums:"autostart,autostop,initiator"`OrganizationIDuuid.UUID       `json:"organization_id,omitempty" format:"uuid"`RequestIDuuid.UUID       `json:"request_id,omitempty" format:"uuid"`}

type CreateTokenRequest struct {Lifetimetime.Duration `json:"lifetime"`ScopeAPIKeyScope   `json:"scope" enums:"all,application_connect"`TokenNamestring        `json:"token_name"`}

type CreateUserRequest struct {Emailstring `json:"email" validate:"required,email" format:"email"`Usernamestring `json:"username" validate:"required,username"`Namestring `json:"name" validate:"user_real_name"`Passwordstring `json:"password"`// UserLoginType defaults to LoginTypePassword.UserLoginTypeLoginType `json:"login_type"`// DisableLogin sets the user's login type to 'none'. This prevents the user// from being able to use a password or any other authentication method to login.// Deprecated: Set UserLoginType=LoginTypeDisabled instead.DisableLoginbool      `json:"disable_login"`OrganizationIDuuid.UUID `json:"organization_id" validate:"" format:"uuid"`}

type CreateUserRequestWithOrgs struct {Emailstring `json:"email" validate:"required,email" format:"email"`Usernamestring `json:"username" validate:"required,username"`Namestring `json:"name" validate:"user_real_name"`Passwordstring `json:"password"`// UserLoginType defaults to LoginTypePassword.UserLoginTypeLoginType `json:"login_type"`// UserStatus defaults to UserStatusDormant.UserStatus *UserStatus `json:"user_status"`// OrganizationIDs is a list of organization IDs that the user should be a member of.OrganizationIDs []uuid.UUID `json:"organization_ids" validate:"" format:"uuid"`}

func (*CreateUserRequestWithOrgs)UnmarshalJSON¶added inv2.15.0

func (r *CreateUserRequestWithOrgs) UnmarshalJSON(data []byte)error

UnmarshalJSON implements the unmarshal for the legacy param "organization_id".To accommodate multiple organizations, the field has been switched to a slice.The previous field will just be appended to the slice.Note in the previous behavior, omitting the field would result in thedefault org being applied, but that is no longer the case.TODO: Remove this method in it's entirety after some period of time.This will be released in v1.16.0, and is associated with the multiple orgsfeature.

type CreateWorkspaceBuildRequest struct {TemplateVersionIDuuid.UUID           `json:"template_version_id,omitempty" format:"uuid"`TransitionWorkspaceTransition `json:"transition" validate:"oneof=start stop delete,required"`DryRunbool                `json:"dry_run,omitempty"`ProvisionerState  []byte              `json:"state,omitempty"`// Orphan may be set for the Destroy transition.Orphanbool `json:"orphan,omitempty"`// ParameterValues are optional. It will write params to the 'workspace' scope.// This will overwrite any existing parameters with the same name.// This will not delete old params not included in this list.RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values,omitempty"`// Log level changes the default logging verbosity of a provider ("info" if empty).LogLevelProvisionerLogLevel `json:"log_level,omitempty" validate:"omitempty,oneof=debug"`// TemplateVersionPresetID is the ID of the template version preset to use for the build.TemplateVersionPresetIDuuid.UUID `json:"template_version_preset_id,omitempty" format:"uuid"`// EnableDynamicParameters skips some of the static parameter checking.// It will default to whatever the template has marked as the default experience.// Requires the "dynamic-experiment" to be used.EnableDynamicParameters *bool `json:"enable_dynamic_parameters,omitempty"`}

type CreateWorkspaceProxyRequest struct {Namestring `json:"name" validate:"required"`DisplayNamestring `json:"display_name"`Iconstring `json:"icon"`}

type CreateWorkspaceRequest struct {// TemplateID specifies which template should be used for creating the workspace.TemplateIDuuid.UUID `json:"template_id,omitempty" validate:"required_without=TemplateVersionID,excluded_with=TemplateVersionID" format:"uuid"`// TemplateVersionID can be used to specify a specific version of a template for creating the workspace.TemplateVersionIDuuid.UUID `json:"template_version_id,omitempty" validate:"required_without=TemplateID,excluded_with=TemplateID" format:"uuid"`Namestring    `json:"name" validate:"workspace_name,required"`AutostartSchedule *string   `json:"autostart_schedule,omitempty"`TTLMillis         *int64    `json:"ttl_ms,omitempty"`// RichParameterValues allows for additional parameters to be provided// during the initial provision.RichParameterValues     []WorkspaceBuildParameter `json:"rich_parameter_values,omitempty"`AutomaticUpdatesAutomaticUpdates          `json:"automatic_updates,omitempty"`TemplateVersionPresetIDuuid.UUID                 `json:"template_version_preset_id,omitempty" format:"uuid"`EnableDynamicParametersbool                      `json:"enable_dynamic_parameters,omitempty"`}

type CryptoKey struct {FeatureCryptoKeyFeature `json:"feature"`Secretstring           `json:"secret"`DeletesAttime.Time        `json:"deletes_at" format:"date-time"`Sequenceint32            `json:"sequence"`StartsAttime.Time        `json:"starts_at" format:"date-time"`}

func (CryptoKey)CanSign¶added inv2.17.0

func (cCryptoKey) CanSign(nowtime.Time)bool

func (CryptoKey)CanVerify¶added inv2.17.0

func (cCryptoKey) CanVerify(nowtime.Time)bool

type CryptoKeyFeaturestring

type CustomRoleRequest struct {Namestring       `json:"name" table:"name,default_sort" validate:"username"`DisplayNamestring       `json:"display_name" table:"display name"`SitePermissions []Permission `json:"site_permissions" table:"site permissions"`// OrganizationPermissions are specific to the organization the role belongs to.OrganizationPermissions []Permission `json:"organization_permissions" table:"organization permissions"`UserPermissions         []Permission `json:"user_permissions" table:"user permissions"`}

type DAUEntry struct {// Date is a string formatted as 2024-01-31.// Timezone and time information is not included.Datestring `json:"date"`Amountint    `json:"amount"`}

type DAURequest struct {TZHourOffsetint}

type DAUsResponse struct {Entries      []DAUEntry `json:"entries"`TZHourOffsetint        `json:"tz_hour_offset"`}

type DERP struct {ServerDERPServerConfig `json:"server" typescript:",notnull"`ConfigDERPConfig       `json:"config" typescript:",notnull"`}

type DERPConfig struct {BlockDirectserpent.Bool   `json:"block_direct" typescript:",notnull"`ForceWebSocketsserpent.Bool   `json:"force_websockets" typescript:",notnull"`URLserpent.String `json:"url" typescript:",notnull"`Pathserpent.String `json:"path" typescript:",notnull"`}

type DERPRegion struct {Preferredbool    `json:"preferred"`LatencyMillisecondsfloat64 `json:"latency_ms"`}

type DERPServerConfig struct {Enableserpent.Bool        `json:"enable" typescript:",notnull"`RegionIDserpent.Int64       `json:"region_id" typescript:",notnull"`RegionCodeserpent.String      `json:"region_code" typescript:",notnull"`RegionNameserpent.String      `json:"region_name" typescript:",notnull"`STUNAddressesserpent.StringArray `json:"stun_addresses" typescript:",notnull"`RelayURLserpent.URL         `json:"relay_url" typescript:",notnull"`}

type DangerousConfig struct {AllowPathAppSharingserpent.Bool `json:"allow_path_app_sharing" typescript:",notnull"`AllowPathAppSiteOwnerAccessserpent.Bool `json:"allow_path_app_site_owner_access" typescript:",notnull"`AllowAllCorsserpent.Bool `json:"allow_all_cors" typescript:",notnull"`}

type DeleteWebpushSubscription struct {Endpointstring `json:"endpoint"`}