Home
/
API
/
Schemas

Schemas

Schemas

agentsdk.AWSInstanceIdentityToken

{
  "document": "string",
  "signature": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
documentstringtrue
signaturestringtrue

agentsdk.AgentMetric

{
  "labels": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "type": "counter",
  "value": 0
}

Properties

NameTypeRequiredRestrictionsDescription
labelsarray of agentsdk.AgentMetricLabelfalse
namestringtrue
typeagentsdk.AgentMetricTypetrue
valuenumbertrue

Enumerated Values

PropertyValue
typecounter
typegauge

agentsdk.AgentMetricLabel

{
  "name": "string",
  "value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringtrue
valuestringtrue

agentsdk.AgentMetricType

"counter"

Properties

Enumerated Values

Value
counter
gauge

agentsdk.AuthenticateResponse

{
  "session_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
session_tokenstringfalse

agentsdk.AzureInstanceIdentityToken

{
  "encoding": "string",
  "signature": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
encodingstringtrue
signaturestringtrue

agentsdk.ExternalAuthResponse

{
  "access_token": "string",
  "password": "string",
  "token_extra": {},
  "type": "string",
  "url": "string",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
access_tokenstringfalse
passwordstringfalse
token_extraobjectfalse
typestringfalse
urlstringfalse
usernamestringfalseDeprecated: Only supported on /workspaceagents/me/gitauth for backwards compatibility.

agentsdk.GitSSHKey

{
  "private_key": "string",
  "public_key": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
private_keystringfalse
public_keystringfalse

agentsdk.GoogleInstanceIdentityToken

{
  "json_web_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
json_web_tokenstringtrue

agentsdk.Log

{
  "created_at": "string",
  "level": "trace",
  "output": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
levelcodersdk.LogLevelfalse
outputstringfalse

agentsdk.Manifest

{
  "agent_id": "string",
  "apps": [
    {
      "command": "string",
      "display_name": "string",
      "external": true,
      "health": "disabled",
      "healthcheck": {
        "interval": 0,
        "threshold": 0,
        "url": "string"
      },
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "sharing_level": "owner",
      "slug": "string",
      "subdomain": true,
      "subdomain_name": "string",
      "url": "string"
    }
  ],
  "derp_force_websockets": true,
  "derpmap": {
    "homeParams": {
      "regionScore": {
        "property1": 0,
        "property2": 0
      }
    },
    "omitDefaultRegions": true,
    "regions": {
      "property1": {
        "avoid": true,
        "embeddedRelay": true,
        "nodes": [
          {
            "canPort80": true,
            "certName": "string",
            "derpport": 0,
            "forceHTTP": true,
            "hostName": "string",
            "insecureForTests": true,
            "ipv4": "string",
            "ipv6": "string",
            "name": "string",
            "regionID": 0,
            "stunonly": true,
            "stunport": 0,
            "stuntestIP": "string"
          }
        ],
        "regionCode": "string",
        "regionID": 0,
        "regionName": "string"
      },
      "property2": {
        "avoid": true,
        "embeddedRelay": true,
        "nodes": [
          {
            "canPort80": true,
            "certName": "string",
            "derpport": 0,
            "forceHTTP": true,
            "hostName": "string",
            "insecureForTests": true,
            "ipv4": "string",
            "ipv6": "string",
            "name": "string",
            "regionID": 0,
            "stunonly": true,
            "stunport": 0,
            "stuntestIP": "string"
          }
        ],
        "regionCode": "string",
        "regionID": 0,
        "regionName": "string"
      }
    }
  },
  "directory": "string",
  "disable_direct_connections": true,
  "environment_variables": {
    "property1": "string",
    "property2": "string"
  },
  "git_auth_configs": 0,
  "metadata": [
    {
      "display_name": "string",
      "interval": 0,
      "key": "string",
      "script": "string",
      "timeout": 0
    }
  ],
  "motd_file": "string",
  "owner_name": "string",
  "scripts": [
    {
      "cron": "string",
      "log_path": "string",
      "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
      "run_on_start": true,
      "run_on_stop": true,
      "script": "string",
      "start_blocks_login": true,
      "timeout": 0
    }
  ],
  "vscode_port_proxy_uri": "string",
  "workspace_id": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
agent_idstringfalse
appsarray of codersdk.WorkspaceAppfalse
derp_force_websocketsbooleanfalse
derpmaptailcfg.DERPMapfalse
directorystringfalse
disable_direct_connectionsbooleanfalse
environment_variablesobjectfalse
» [any property]stringfalse
git_auth_configsintegerfalseGit auth configs stores the number of Git configurations the Coder deployment has. If this number is >0, we set up special configuration in the workspace.
metadataarray of codersdk.WorkspaceAgentMetadataDescriptionfalse
motd_filestringfalse
owner_namestringfalseOwner name and WorkspaceID are used by an open-source user to identify the workspace. We do not provide insurance that this will not be removed in the future, but if it's easy to persist lets keep it around.
scriptsarray of codersdk.WorkspaceAgentScriptfalse
vscode_port_proxy_uristringfalse
workspace_idstringfalse

agentsdk.Metadata

{
  "age": 0,
  "collected_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "key": "string",
  "value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
ageintegerfalseAge is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew.
collected_atstringfalse
errorstringfalse
keystringfalse
valuestringfalse

agentsdk.PatchLogs

{
  "log_source_id": "string",
  "logs": [
    {
      "created_at": "string",
      "level": "trace",
      "output": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
log_source_idstringfalse
logsarray of agentsdk.Logfalse

agentsdk.PostAppHealthsRequest

{
  "healths": {
    "property1": "disabled",
    "property2": "disabled"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
healthsobjectfalseHealths is a map of the workspace app name and the health of the app.
» [any property]codersdk.WorkspaceAppHealthfalse

agentsdk.PostLifecycleRequest

{
  "changed_at": "string",
  "state": "created"
}

Properties

NameTypeRequiredRestrictionsDescription
changed_atstringfalse
statecodersdk.WorkspaceAgentLifecyclefalse

agentsdk.PostMetadataRequest

{
  "metadata": [
    {
      "age": 0,
      "collected_at": "2019-08-24T14:15:22Z",
      "error": "string",
      "key": "string",
      "value": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
metadataarray of agentsdk.Metadatafalse

agentsdk.PostMetadataRequestDeprecated

{
  "age": 0,
  "collected_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
ageintegerfalseAge is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew.
collected_atstringfalse
errorstringfalse
valuestringfalse

agentsdk.PostStartupRequest

{
  "expanded_directory": "string",
  "subsystems": ["envbox"],
  "version": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
expanded_directorystringfalse
subsystemsarray of codersdk.AgentSubsystemfalse
versionstringfalse

agentsdk.Stats

{
  "connection_count": 0,
  "connection_median_latency_ms": 0,
  "connections_by_proto": {
    "property1": 0,
    "property2": 0
  },
  "metrics": [
    {
      "labels": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "type": "counter",
      "value": 0
    }
  ],
  "rx_bytes": 0,
  "rx_packets": 0,
  "session_count_jetbrains": 0,
  "session_count_reconnecting_pty": 0,
  "session_count_ssh": 0,
  "session_count_vscode": 0,
  "tx_bytes": 0,
  "tx_packets": 0
}

Properties

NameTypeRequiredRestrictionsDescription
connection_countintegerfalseConnection count is the number of connections received by an agent.
connection_median_latency_msnumberfalseConnection median latency ms is the median latency of all connections in milliseconds.
connections_by_protoobjectfalseConnections by proto is a count of connections by protocol.
» [any property]integerfalse
metricsarray of agentsdk.AgentMetricfalseMetrics collected by the agent
rx_bytesintegerfalseRx bytes is the number of received bytes.
rx_packetsintegerfalseRx packets is the number of received packets.
session_count_jetbrainsintegerfalseSession count jetbrains is the number of connections received by an agent that are from our JetBrains extension.
session_count_reconnecting_ptyintegerfalseSession count reconnecting pty is the number of connections received by an agent that are from the reconnecting web terminal.
session_count_sshintegerfalseSession count ssh is the number of connections received by an agent that are normal, non-tagged SSH sessions.
session_count_vscodeintegerfalseSession count vscode is the number of connections received by an agent that are from our VS Code extension.
tx_bytesintegerfalseTx bytes is the number of transmitted bytes.
tx_packetsintegerfalseTx packets is the number of transmitted bytes.

agentsdk.StatsResponse

{
  "report_interval": 0
}

Properties

NameTypeRequiredRestrictionsDescription
report_intervalintegerfalseReport interval is the duration after which the agent should send stats again.

clibase.Annotations

{
  "property1": "string",
  "property2": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
[any property]stringfalse

clibase.Group

{
  "description": "string",
  "name": "string",
  "parent": {
    "description": "string",
    "name": "string",
    "parent": {},
    "yaml": "string"
  },
  "yaml": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
descriptionstringfalse
namestringfalse
parentclibase.Groupfalse
yamlstringfalse

clibase.HostPort

{
  "host": "string",
  "port": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
hoststringfalse
portstringfalse

clibase.Option

{
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "default": "string",
  "description": "string",
  "env": "string",
  "flag": "string",
  "flag_shorthand": "string",
  "group": {
    "description": "string",
    "name": "string",
    "parent": {
      "description": "string",
      "name": "string",
      "parent": {},
      "yaml": "string"
    },
    "yaml": "string"
  },
  "hidden": true,
  "name": "string",
  "required": true,
  "use_instead": [
    {
      "annotations": {
        "property1": "string",
        "property2": "string"
      },
      "default": "string",
      "description": "string",
      "env": "string",
      "flag": "string",
      "flag_shorthand": "string",
      "group": {
        "description": "string",
        "name": "string",
        "parent": {
          "description": "string",
          "name": "string",
          "parent": {},
          "yaml": "string"
        },
        "yaml": "string"
      },
      "hidden": true,
      "name": "string",
      "required": true,
      "use_instead": [],
      "value": null,
      "value_source": "",
      "yaml": "string"
    }
  ],
  "value": null,
  "value_source": "",
  "yaml": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
annotationsclibase.AnnotationsfalseAnnotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation.
defaultstringfalseDefault is parsed into Value if set.
descriptionstringfalse
envstringfalseEnv is the environment variable used to configure this option. If unset, environment configuring is disabled.
flagstringfalseFlag is the long name of the flag used to configure this option. If unset, flag configuring is disabled.
flag_shorthandstringfalseFlag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used.
groupclibase.GroupfalseGroup is a group hierarchy that helps organize this option in help, configs and other documentation.
hiddenbooleanfalse
namestringfalse
requiredbooleanfalseRequired means this value must be set by some means. It requires ValueSource != ValueSourceNone If Default is set, then Required is ignored.
use_insteadarray of clibase.OptionfalseUse instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning.
valueanyfalseValue includes the types listed in values.go.
value_sourceclibase.ValueSourcefalse
yamlstringfalseYaml is the YAML key used to configure this option. If unset, YAML configuring is disabled.

clibase.Regexp

{}

Properties

None

clibase.Struct-array_codersdk_ExternalAuthConfig

{
  "value": [
    {
      "app_install_url": "string",
      "app_installations_url": "string",
      "auth_url": "string",
      "client_id": "string",
      "device_code_url": "string",
      "device_flow": true,
      "display_icon": "string",
      "display_name": "string",
      "extra_token_keys": ["string"],
      "id": "string",
      "no_refresh": true,
      "regex": "string",
      "scopes": ["string"],
      "token_url": "string",
      "type": "string",
      "validate_url": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
valuearray of codersdk.ExternalAuthConfigfalse

clibase.Struct-array_codersdk_LinkConfig

{
  "value": [
    {
      "icon": "string",
      "name": "string",
      "target": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
valuearray of codersdk.LinkConfigfalse

clibase.URL

{
  "forceQuery": true,
  "fragment": "string",
  "host": "string",
  "omitHost": true,
  "opaque": "string",
  "path": "string",
  "rawFragment": "string",
  "rawPath": "string",
  "rawQuery": "string",
  "scheme": "string",
  "user": {}
}

Properties

NameTypeRequiredRestrictionsDescription
forceQuerybooleanfalseappend a query ('?') even if RawQuery is empty
fragmentstringfalsefragment for references, without '#'
hoststringfalsehost or host:port
omitHostbooleanfalsedo not emit empty host (authority)
opaquestringfalseencoded opaque data
pathstringfalsepath (relative paths may omit leading slash)
rawFragmentstringfalseencoded fragment hint (see EscapedFragment method)
rawPathstringfalseencoded path hint (see EscapedPath method)
rawQuerystringfalseencoded query values, without '?'
schemestringfalse
userurl.Userinfofalseusername and password information

clibase.ValueSource

""

Properties

Enumerated Values

Value
``
flag
env
yaml
default

coderd.SCIMUser

{
  "active": true,
  "emails": [
    {
      "display": "string",
      "primary": true,
      "type": "string",
      "value": "[email protected]"
    }
  ],
  "groups": [null],
  "id": "string",
  "meta": {
    "resourceType": "string"
  },
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "schemas": ["string"],
  "userName": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
activebooleanfalse
emailsarray of objectfalse
» displaystringfalse
» primarybooleanfalse
» typestringfalse
» valuestringfalse
groupsarray of undefinedfalse
idstringfalse
metaobjectfalse
» resourceTypestringfalse
nameobjectfalse
» familyNamestringfalse
» givenNamestringfalse
schemasarray of stringfalse
userNamestringfalse

coderd.cspViolation

{
  "csp-report": {}
}

Properties

NameTypeRequiredRestrictionsDescription
csp-reportobjectfalse

codersdk.ACLAvailable

{
  "groups": [
    {
      "avatar_url": "string",
      "display_name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "members": [
        {
          "avatar_url": "http://example.com",
          "created_at": "2019-08-24T14:15:22Z",
          "email": "[email protected]",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "last_seen_at": "2019-08-24T14:15:22Z",
          "login_type": "",
          "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
          "roles": [
            {
              "display_name": "string",
              "name": "string"
            }
          ],
          "status": "active",
          "username": "string"
        }
      ],
      "name": "string",
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "quota_allowance": 0,
      "source": "user"
    }
  ],
  "users": [
    {
      "avatar_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "[email protected]",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_seen_at": "2019-08-24T14:15:22Z",
      "login_type": "",
      "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
      "roles": [
        {
          "display_name": "string",
          "name": "string"
        }
      ],
      "status": "active",
      "username": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
groupsarray of codersdk.Groupfalse
usersarray of codersdk.Userfalse

codersdk.APIKey

{
  "created_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "id": "string",
  "last_used": "2019-08-24T14:15:22Z",
  "lifetime_seconds": 0,
  "login_type": "password",
  "scope": "all",
  "token_name": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringtrue
expires_atstringtrue
idstringtrue
last_usedstringtrue
lifetime_secondsintegertrue
login_typecodersdk.LoginTypetrue
scopecodersdk.APIKeyScopetrue
token_namestringtrue
updated_atstringtrue
user_idstringtrue

Enumerated Values

PropertyValue
login_typepassword
login_typegithub
login_typeoidc
login_typetoken
scopeall
scopeapplication_connect

codersdk.APIKeyScope

"all"

Properties

Enumerated Values

Value
all
application_connect

codersdk.AddLicenseRequest

{
  "license": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
licensestringtrue

codersdk.AgentSubsystem

"envbox"

Properties

Enumerated Values

Value
envbox
envbuilder
exectrace

codersdk.AppHostResponse

{
  "host": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
hoststringfalseHost is the externally accessible URL for the Coder instance.

codersdk.AppearanceConfig

{
  "application_name": "string",
  "logo_url": "string",
  "service_banner": {
    "background_color": "string",
    "enabled": true,
    "message": "string"
  },
  "support_links": [
    {
      "icon": "string",
      "name": "string",
      "target": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
application_namestringfalse
logo_urlstringfalse
service_bannercodersdk.ServiceBannerConfigfalse
support_linksarray of codersdk.LinkConfigfalse

codersdk.ArchiveTemplateVersionsRequest

{
  "all": true
}

Properties

NameTypeRequiredRestrictionsDescription
allbooleanfalseBy default, only failed versions are archived. Set this to true to archive all unused versions regardless of job status.

codersdk.AssignableRoles

{
  "assignable": true,
  "display_name": "string",
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
assignablebooleanfalse
display_namestringfalse
namestringfalse

codersdk.AuditAction

"create"

Properties

Enumerated Values

Value
create
write
delete
start
stop
login
logout
register

codersdk.AuditDiff

{
  "property1": {
    "new": null,
    "old": null,
    "secret": true
  },
  "property2": {
    "new": null,
    "old": null,
    "secret": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
[any property]codersdk.AuditDiffFieldfalse

codersdk.AuditDiffField

{
  "new": null,
  "old": null,
  "secret": true
}

Properties

NameTypeRequiredRestrictionsDescription
newanyfalse
oldanyfalse
secretbooleanfalse

codersdk.AuditLog

{
  "action": "create",
  "additional_fields": [0],
  "description": "string",
  "diff": {
    "property1": {
      "new": null,
      "old": null,
      "secret": true
    },
    "property2": {
      "new": null,
      "old": null,
      "secret": true
    }
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "ip": "string",
  "is_deleted": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  "resource_icon": "string",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "resource_link": "string",
  "resource_target": "string",
  "resource_type": "template",
  "status_code": 0,
  "time": "2019-08-24T14:15:22Z",
  "user": {
    "avatar_url": "http://example.com",
    "created_at": "2019-08-24T14:15:22Z",
    "email": "[email protected]",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "last_seen_at": "2019-08-24T14:15:22Z",
    "login_type": "",
    "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "roles": [
      {
        "display_name": "string",
        "name": "string"
      }
    ],
    "status": "active",
    "username": "string"
  },
  "user_agent": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
actioncodersdk.AuditActionfalse
additional_fieldsarray of integerfalse
descriptionstringfalse
diffcodersdk.AuditDifffalse
idstringfalse
ipstringfalse
is_deletedbooleanfalse
organization_idstringfalse
request_idstringfalse
resource_iconstringfalse
resource_idstringfalse
resource_linkstringfalse
resource_targetstringfalseResource target is the name of the resource.
resource_typecodersdk.ResourceTypefalse
status_codeintegerfalse
timestringfalse
usercodersdk.Userfalse
user_agentstringfalse

codersdk.AuditLogResponse

{
  "audit_logs": [
    {
      "action": "create",
      "additional_fields": [0],
      "description": "string",
      "diff": {
        "property1": {
          "new": null,
          "old": null,
          "secret": true
        },
        "property2": {
          "new": null,
          "old": null,
          "secret": true
        }
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "ip": "string",
      "is_deleted": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
      "resource_icon": "string",
      "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
      "resource_link": "string",
      "resource_target": "string",
      "resource_type": "template",
      "status_code": 0,
      "time": "2019-08-24T14:15:22Z",
      "user": {
        "avatar_url": "http://example.com",
        "created_at": "2019-08-24T14:15:22Z",
        "email": "[email protected]",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "last_seen_at": "2019-08-24T14:15:22Z",
        "login_type": "",
        "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
        "roles": [
          {
            "display_name": "string",
            "name": "string"
          }
        ],
        "status": "active",
        "username": "string"
      },
      "user_agent": "string"
    }
  ],
  "count": 0
}

Properties

NameTypeRequiredRestrictionsDescription
audit_logsarray of codersdk.AuditLogfalse
countintegerfalse

codersdk.AuthMethod

{
  "enabled": true
}

Properties

NameTypeRequiredRestrictionsDescription
enabledbooleanfalse

codersdk.AuthMethods

{
  "github": {
    "enabled": true
  },
  "oidc": {
    "enabled": true,
    "iconUrl": "string",
    "signInText": "string"
  },
  "password": {
    "enabled": true
  }
}

Properties

NameTypeRequiredRestrictionsDescription
githubcodersdk.AuthMethodfalse
oidccodersdk.OIDCAuthMethodfalse
passwordcodersdk.AuthMethodfalse

codersdk.AuthorizationCheck

{
  "action": "create",
  "object": {
    "organization_id": "string",
    "owner_id": "string",
    "resource_id": "string",
    "resource_type": "workspace"
  }
}

AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.

Properties

NameTypeRequiredRestrictionsDescription
actionstringfalse
objectcodersdk.AuthorizationObjectfalseObject 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.

Enumerated Values

PropertyValue
actioncreate
actionread
actionupdate
actiondelete

codersdk.AuthorizationObject

{
  "organization_id": "string",
  "owner_id": "string",
  "resource_id": "string",
  "resource_type": "workspace"
}

AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, all workspaces across the entire product.

Properties

NameTypeRequiredRestrictionsDescription
organization_idstringfalseOrganization ID (optional) adds the set constraint to all resources owned by a given organization.
owner_idstringfalseOwner ID (optional) adds the set constraint to all resources owned by a given user.
resource_idstringfalseResource ID (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.
resource_typecodersdk.RBACResourcefalseResource type is the name of the resource. ./coderd/rbac/object.go has the list of valid resource types.

codersdk.AuthorizationRequest

{
  "checks": {
    "property1": {
      "action": "create",
      "object": {
        "organization_id": "string",
        "owner_id": "string",
        "resource_id": "string",
        "resource_type": "workspace"
      }
    },
    "property2": {
      "action": "create",
      "object": {
        "organization_id": "string",
        "owner_id": "string",
        "resource_id": "string",
        "resource_type": "workspace"
      }
    }
  }
}

Properties

NameTypeRequiredRestrictionsDescription
checksobjectfalseChecks 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.
» [any property]codersdk.AuthorizationCheckfalseIt is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.

codersdk.AuthorizationResponse

{
  "property1": true,
  "property2": true
}

Properties

NameTypeRequiredRestrictionsDescription
[any property]booleanfalse

codersdk.AutomaticUpdates

"always"

Properties

Enumerated Values

Value
always
never

codersdk.BuildInfoResponse

{
  "agent_api_version": "string",
  "dashboard_url": "string",
  "external_url": "string",
  "version": "string",
  "workspace_proxy": true
}

Properties

NameTypeRequiredRestrictionsDescription
agent_api_versionstringfalseAgent api version is the current version of the Agent API (back versions MAY still be supported).
dashboard_urlstringfalseDashboard URL is the URL to hit the deployment's dashboard. For external workspace proxies, this is the coderd they are connected to.
external_urlstringfalseExternal URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit.
versionstringfalseVersion returns the semantic version of the build.
workspace_proxybooleanfalse

codersdk.BuildReason

"initiator"

Properties

Enumerated Values

Value
initiator
autostart
autostop

codersdk.ConnectionLatency

{
  "p50": 31.312,
  "p95": 119.832
}

Properties

NameTypeRequiredRestrictionsDescription
p50numberfalse
p95numberfalse

codersdk.ConvertLoginRequest

{
  "password": "string",
  "to_type": ""
}

Properties

NameTypeRequiredRestrictionsDescription
passwordstringtrue
to_typecodersdk.LoginTypetrueTo type is the login type to convert to.

codersdk.CreateFirstUserRequest

{
  "email": "string",
  "password": "string",
  "trial": true,
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
emailstringtrue
passwordstringtrue
trialbooleanfalse
usernamestringtrue

codersdk.CreateFirstUserResponse

{
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
organization_idstringfalse
user_idstringfalse

codersdk.CreateGroupRequest

{
  "avatar_url": "string",
  "display_name": "string",
  "name": "string",
  "quota_allowance": 0
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
display_namestringfalse
namestringfalse
quota_allowanceintegerfalse

codersdk.CreateOrganizationRequest

{
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringtrue

codersdk.CreateTemplateRequest

{
  "allow_user_autostart": true,
  "allow_user_autostop": true,
  "allow_user_cancel_workspace_jobs": true,
  "autostart_requirement": {
    "days_of_week": ["monday"]
  },
  "autostop_requirement": {
    "days_of_week": ["monday"],
    "weeks": 0
  },
  "default_ttl_ms": 0,
  "delete_ttl_ms": 0,
  "description": "string",
  "disable_everyone_group_access": true,
  "display_name": "string",
  "dormant_ttl_ms": 0,
  "failure_ttl_ms": 0,
  "icon": "string",
  "max_ttl_ms": 0,
  "name": "string",
  "require_active_version": true,
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1"
}

Properties

NameTypeRequiredRestrictionsDescription
allow_user_autostartbooleanfalseAllow user autostart 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.
allow_user_autostopbooleanfalseAllow user autostop 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.
allow_user_cancel_workspace_jobsbooleanfalseAllow users to cancel in-progress workspace jobs. *bool as the default value is "true".
autostart_requirementcodersdk.TemplateAutostartRequirementfalseAutostart requirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is an enterprise feature.
autostop_requirementcodersdk.TemplateAutostopRequirementfalseAutostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature.
default_ttl_msintegerfalseDefault ttl ms allows optionally specifying the default TTL for all workspaces created from this template.
delete_ttl_msintegerfalseDelete ttl ms allows optionally specifying the max lifetime before Coder permanently deletes dormant workspaces created from this template.
descriptionstringfalseDescription is a description of what the template contains. It must be less than 128 bytes.
disable_everyone_group_accessbooleanfalseDisable everyone group access 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.
display_namestringfalseDisplay name is the displayed name of the template.
dormant_ttl_msintegerfalseDormant ttl ms allows optionally specifying the max lifetime before Coder locks inactive workspaces created from this template.
failure_ttl_msintegerfalseFailure ttl ms allows optionally specifying the max lifetime before Coder stops all resources for failed workspaces created from this template.
iconstringfalseIcon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
max_ttl_msintegerfalseMax ttl ms remove max_ttl once autostop_requirement is matured
namestringtrueName is the name of the template.
require_active_versionbooleanfalseRequire active version mandates that workspaces are built with the active template version.
template_version_idstringtrueTemplate version ID 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.

codersdk.CreateTemplateVersionDryRunRequest

{
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "user_variable_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "workspace_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
rich_parameter_valuesarray of codersdk.WorkspaceBuildParameterfalse
user_variable_valuesarray of codersdk.VariableValuefalse
workspace_namestringfalse

codersdk.CreateTemplateVersionRequest

{
  "example_id": "string",
  "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  "message": "string",
  "name": "string",
  "provisioner": "terraform",
  "storage_method": "file",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "user_variable_values": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
example_idstringfalse
file_idstringfalse
messagestringfalse
namestringfalse
provisionerstringtrue
storage_methodcodersdk.ProvisionerStorageMethodtrue
tagsobjectfalse
» [any property]stringfalse
template_idstringfalseTemplate ID optionally associates a version with a template.
user_variable_valuesarray of codersdk.VariableValuefalse

Enumerated Values

PropertyValue
provisionerterraform
provisionerecho
storage_methodfile

codersdk.CreateTestAuditLogRequest

{
  "action": "create",
  "additional_fields": [0],
  "build_reason": "autostart",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "resource_type": "template",
  "time": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
actioncodersdk.AuditActionfalse
additional_fieldsarray of integerfalse
build_reasoncodersdk.BuildReasonfalse
resource_idstringfalse
resource_typecodersdk.ResourceTypefalse
timestringfalse

Enumerated Values

PropertyValue
actioncreate
actionwrite
actiondelete
actionstart
actionstop
build_reasonautostart
build_reasonautostop
build_reasoninitiator
resource_typetemplate
resource_typetemplate_version
resource_typeuser
resource_typeworkspace
resource_typeworkspace_build
resource_typegit_ssh_key
resource_typeauditable_group

codersdk.CreateTokenRequest

{
  "lifetime": 0,
  "scope": "all",
  "token_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
lifetimeintegerfalse
scopecodersdk.APIKeyScopefalse
token_namestringfalse

Enumerated Values

PropertyValue
scopeall
scopeapplication_connect

codersdk.CreateUserRequest

{
  "disable_login": true,
  "email": "[email protected]",
  "login_type": "",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "password": "string",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
disable_loginbooleanfalseDisable login 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.
emailstringtrue
login_typecodersdk.LoginTypefalseLogin type defaults to LoginTypePassword.
organization_idstringfalse
passwordstringfalse
usernamestringtrue

codersdk.CreateWorkspaceBuildRequest

{
  "dry_run": true,
  "log_level": "debug",
  "orphan": true,
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "state": [0],
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "transition": "create"
}

Properties

NameTypeRequiredRestrictionsDescription
dry_runbooleanfalse
log_levelcodersdk.ProvisionerLogLevelfalseLog level changes the default logging verbosity of a provider ("info" if empty).
orphanbooleanfalseOrphan may be set for the Destroy transition.
rich_parameter_valuesarray of codersdk.WorkspaceBuildParameterfalseRich parameter values 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.
statearray of integerfalse
template_version_idstringfalse
transitioncodersdk.WorkspaceTransitiontrue

Enumerated Values

PropertyValue
log_leveldebug
transitioncreate
transitionstart
transitionstop
transitiondelete

codersdk.CreateWorkspaceProxyRequest

{
  "display_name": "string",
  "icon": "string",
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
display_namestringfalse
iconstringfalse
namestringtrue

codersdk.CreateWorkspaceRequest

{
  "automatic_updates": "always",
  "autostart_schedule": "string",
  "name": "string",
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "ttl_ms": 0
}

Properties

NameTypeRequiredRestrictionsDescription
automatic_updatescodersdk.AutomaticUpdatesfalse
autostart_schedulestringfalse
namestringtrue
rich_parameter_valuesarray of codersdk.WorkspaceBuildParameterfalseRich parameter values allows for additional parameters to be provided during the initial provision.
template_idstringfalseTemplate ID specifies which template should be used for creating the workspace.
template_version_idstringfalseTemplate version ID can be used to specify a specific version of a template for creating the workspace.
ttl_msintegerfalse

codersdk.DAUEntry

{
  "amount": 0,
  "date": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
amountintegerfalse
datestringfalse

codersdk.DAUsResponse

{
  "entries": [
    {
      "amount": 0,
      "date": "2019-08-24T14:15:22Z"
    }
  ],
  "tz_hour_offset": 0
}

Properties

NameTypeRequiredRestrictionsDescription
entriesarray of codersdk.DAUEntryfalse
tz_hour_offsetintegerfalse

codersdk.DERP

{
  "config": {
    "block_direct": true,
    "force_websockets": true,
    "path": "string",
    "url": "string"
  },
  "server": {
    "enable": true,
    "region_code": "string",
    "region_id": 0,
    "region_name": "string",
    "relay_url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    },
    "stun_addresses": ["string"]
  }
}

Properties

NameTypeRequiredRestrictionsDescription
configcodersdk.DERPConfigfalse
servercodersdk.DERPServerConfigfalse

codersdk.DERPConfig

{
  "block_direct": true,
  "force_websockets": true,
  "path": "string",
  "url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
block_directbooleanfalse
force_websocketsbooleanfalse
pathstringfalse
urlstringfalse

codersdk.DERPRegion

{
  "latency_ms": 0,
  "preferred": true
}

Properties

NameTypeRequiredRestrictionsDescription
latency_msnumberfalse
preferredbooleanfalse

codersdk.DERPServerConfig

{
  "enable": true,
  "region_code": "string",
  "region_id": 0,
  "region_name": "string",
  "relay_url": {
    "forceQuery": true,
    "fragment": "string",
    "host": "string",
    "omitHost": true,
    "opaque": "string",
    "path": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "scheme": "string",
    "user": {}
  },
  "stun_addresses": ["string"]
}

Properties

NameTypeRequiredRestrictionsDescription
enablebooleanfalse
region_codestringfalse
region_idintegerfalse
region_namestringfalse
relay_urlclibase.URLfalse
stun_addressesarray of stringfalse

codersdk.DangerousConfig

{
  "allow_all_cors": true,
  "allow_path_app_sharing": true,
  "allow_path_app_site_owner_access": true
}

Properties

NameTypeRequiredRestrictionsDescription
allow_all_corsbooleanfalse
allow_path_app_sharingbooleanfalse
allow_path_app_site_owner_accessbooleanfalse

codersdk.DeploymentConfig

{
  "config": {
    "access_url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    },
    "address": {
      "host": "string",
      "port": "string"
    },
    "agent_fallback_troubleshooting_url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    },
    "agent_stat_refresh_interval": 0,
    "autobuild_poll_interval": 0,
    "browser_only": true,
    "cache_directory": "string",
    "config": "string",
    "config_ssh": {
      "deploymentName": "string",
      "sshconfigOptions": ["string"]
    },
    "dangerous": {
      "allow_all_cors": true,
      "allow_path_app_sharing": true,
      "allow_path_app_site_owner_access": true
    },
    "derp": {
      "config": {
        "block_direct": true,
        "force_websockets": true,
        "path": "string",
        "url": "string"
      },
      "server": {
        "enable": true,
        "region_code": "string",
        "region_id": 0,
        "region_name": "string",
        "relay_url": {
          "forceQuery": true,
          "fragment": "string",
          "host": "string",
          "omitHost": true,
          "opaque": "string",
          "path": "string",
          "rawFragment": "string",
          "rawPath": "string",
          "rawQuery": "string",
          "scheme": "string",
          "user": {}
        },
        "stun_addresses": ["string"]
      }
    },
    "disable_owner_workspace_exec": true,
    "disable_password_auth": true,
    "disable_path_apps": true,
    "disable_session_expiry_refresh": true,
    "docs_url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    },
    "enable_terraform_debug_mode": true,
    "experiments": ["string"],
    "external_auth": {
      "value": [
        {
          "app_install_url": "string",
          "app_installations_url": "string",
          "auth_url": "string",
          "client_id": "string",
          "device_code_url": "string",
          "device_flow": true,
          "display_icon": "string",
          "display_name": "string",
          "extra_token_keys": ["string"],
          "id": "string",
          "no_refresh": true,
          "regex": "string",
          "scopes": ["string"],
          "token_url": "string",
          "type": "string",
          "validate_url": "string"
        }
      ]
    },
    "external_token_encryption_keys": ["string"],
    "healthcheck": {
      "refresh": 0,
      "threshold_database": 0
    },
    "http_address": "string",
    "in_memory_database": true,
    "job_hang_detector_interval": 0,
    "logging": {
      "human": "string",
      "json": "string",
      "log_filter": ["string"],
      "stackdriver": "string"
    },
    "max_session_expiry": 0,
    "max_token_lifetime": 0,
    "metrics_cache_refresh_interval": 0,
    "oauth2": {
      "github": {
        "allow_everyone": true,
        "allow_signups": true,
        "allowed_orgs": ["string"],
        "allowed_teams": ["string"],
        "client_id": "string",
        "client_secret": "string",
        "enterprise_base_url": "string"
      }
    },
    "oidc": {
      "allow_signups": true,
      "auth_url_params": {},
      "client_cert_file": "string",
      "client_id": "string",
      "client_key_file": "string",
      "client_secret": "string",
      "email_domain": ["string"],
      "email_field": "string",
      "group_allow_list": ["string"],
      "group_auto_create": true,
      "group_mapping": {},
      "group_regex_filter": {},
      "groups_field": "string",
      "icon_url": {
        "forceQuery": true,
        "fragment": "string",
        "host": "string",
        "omitHost": true,
        "opaque": "string",
        "path": "string",
        "rawFragment": "string",
        "rawPath": "string",
        "rawQuery": "string",
        "scheme": "string",
        "user": {}
      },
      "ignore_email_verified": true,
      "ignore_user_info": true,
      "issuer_url": "string",
      "scopes": ["string"],
      "sign_in_text": "string",
      "user_role_field": "string",
      "user_role_mapping": {},
      "user_roles_default": ["string"],
      "username_field": "string"
    },
    "pg_connection_url": "string",
    "pprof": {
      "address": {
        "host": "string",
        "port": "string"
      },
      "enable": true
    },
    "prometheus": {
      "address": {
        "host": "string",
        "port": "string"
      },
      "collect_agent_stats": true,
      "collect_db_metrics": true,
      "enable": true
    },
    "provisioner": {
      "daemon_poll_interval": 0,
      "daemon_poll_jitter": 0,
      "daemon_psk": "string",
      "daemons": 0,
      "daemons_echo": true,
      "force_cancel_interval": 0
    },
    "proxy_health_status_interval": 0,
    "proxy_trusted_headers": ["string"],
    "proxy_trusted_origins": ["string"],
    "rate_limit": {
      "api": 0,
      "disable_all": true
    },
    "redirect_to_access_url": true,
    "scim_api_key": "string",
    "secure_auth_cookie": true,
    "ssh_keygen_algorithm": "string",
    "strict_transport_security": 0,
    "strict_transport_security_options": ["string"],
    "support": {
      "links": {
        "value": [
          {
            "icon": "string",
            "name": "string",
            "target": "string"
          }
        ]
      }
    },
    "swagger": {
      "enable": true
    },
    "telemetry": {
      "enable": true,
      "trace": true,
      "url": {
        "forceQuery": true,
        "fragment": "string",
        "host": "string",
        "omitHost": true,
        "opaque": "string",
        "path": "string",
        "rawFragment": "string",
        "rawPath": "string",
        "rawQuery": "string",
        "scheme": "string",
        "user": {}
      }
    },
    "tls": {
      "address": {
        "host": "string",
        "port": "string"
      },
      "allow_insecure_ciphers": true,
      "cert_file": ["string"],
      "client_auth": "string",
      "client_ca_file": "string",
      "client_cert_file": "string",
      "client_key_file": "string",
      "enable": true,
      "key_file": ["string"],
      "min_version": "string",
      "redirect_http": true,
      "supported_ciphers": ["string"]
    },
    "trace": {
      "capture_logs": true,
      "data_dog": true,
      "enable": true,
      "honeycomb_api_key": "string"
    },
    "update_check": true,
    "user_quiet_hours_schedule": {
      "default_schedule": "string"
    },
    "verbose": true,
    "web_terminal_renderer": "string",
    "wgtunnel_host": "string",
    "wildcard_access_url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    },
    "write_config": true
  },
  "options": [
    {
      "annotations": {
        "property1": "string",
        "property2": "string"
      },
      "default": "string",
      "description": "string",
      "env": "string",
      "flag": "string",
      "flag_shorthand": "string",
      "group": {
        "description": "string",
        "name": "string",
        "parent": {
          "description": "string",
          "name": "string",
          "parent": {},
          "yaml": "string"
        },
        "yaml": "string"
      },
      "hidden": true,
      "name": "string",
      "required": true,
      "use_instead": [{}],
      "value": null,
      "value_source": "",
      "yaml": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
configcodersdk.DeploymentValuesfalse
optionsarray of clibase.Optionfalse

codersdk.DeploymentStats

{
  "aggregated_from": "2019-08-24T14:15:22Z",
  "collected_at": "2019-08-24T14:15:22Z",
  "next_update_at": "2019-08-24T14:15:22Z",
  "session_count": {
    "jetbrains": 0,
    "reconnecting_pty": 0,
    "ssh": 0,
    "vscode": 0
  },
  "workspaces": {
    "building": 0,
    "connection_latency_ms": {
      "p50": 0,
      "p95": 0
    },
    "failed": 0,
    "pending": 0,
    "running": 0,
    "rx_bytes": 0,
    "stopped": 0,
    "tx_bytes": 0
  }
}

Properties

NameTypeRequiredRestrictionsDescription
aggregated_fromstringfalseAggregated from is the time in which stats are aggregated from. This might be back in time a specific duration or interval.
collected_atstringfalseCollected at is the time in which stats are collected at.
next_update_atstringfalseNext update at is the time when the next batch of stats will be updated.
session_countcodersdk.SessionCountDeploymentStatsfalse
workspacescodersdk.WorkspaceDeploymentStatsfalse

codersdk.DeploymentValues

{
  "access_url": {
    "forceQuery": true,
    "fragment": "string",
    "host": "string",
    "omitHost": true,
    "opaque": "string",
    "path": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "scheme": "string",
    "user": {}
  },
  "address": {
    "host": "string",
    "port": "string"
  },
  "agent_fallback_troubleshooting_url": {
    "forceQuery": true,
    "fragment": "string",
    "host": "string",
    "omitHost": true,
    "opaque": "string",
    "path": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "scheme": "string",
    "user": {}
  },
  "agent_stat_refresh_interval": 0,
  "autobuild_poll_interval": 0,
  "browser_only": true,
  "cache_directory": "string",
  "config": "string",
  "config_ssh": {
    "deploymentName": "string",
    "sshconfigOptions": ["string"]
  },
  "dangerous": {
    "allow_all_cors": true,
    "allow_path_app_sharing": true,
    "allow_path_app_site_owner_access": true
  },
  "derp": {
    "config": {
      "block_direct": true,
      "force_websockets": true,
      "path": "string",
      "url": "string"
    },
    "server": {
      "enable": true,
      "region_code": "string",
      "region_id": 0,
      "region_name": "string",
      "relay_url": {
        "forceQuery": true,
        "fragment": "string",
        "host": "string",
        "omitHost": true,
        "opaque": "string",
        "path": "string",
        "rawFragment": "string",
        "rawPath": "string",
        "rawQuery": "string",
        "scheme": "string",
        "user": {}
      },
      "stun_addresses": ["string"]
    }
  },
  "disable_owner_workspace_exec": true,
  "disable_password_auth": true,
  "disable_path_apps": true,
  "disable_session_expiry_refresh": true,
  "docs_url": {
    "forceQuery": true,
    "fragment": "string",
    "host": "string",
    "omitHost": true,
    "opaque": "string",
    "path": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "scheme": "string",
    "user": {}
  },
  "enable_terraform_debug_mode": true,
  "experiments": ["string"],
  "external_auth": {
    "value": [
      {
        "app_install_url": "string",
        "app_installations_url": "string",
        "auth_url": "string",
        "client_id": "string",
        "device_code_url": "string",
        "device_flow": true,
        "display_icon": "string",
        "display_name": "string",
        "extra_token_keys": ["string"],
        "id": "string",
        "no_refresh": true,
        "regex": "string",
        "scopes": ["string"],
        "token_url": "string",
        "type": "string",
        "validate_url": "string"
      }
    ]
  },
  "external_token_encryption_keys": ["string"],
  "healthcheck": {
    "refresh": 0,
    "threshold_database": 0
  },
  "http_address": "string",
  "in_memory_database": true,
  "job_hang_detector_interval": 0,
  "logging": {
    "human": "string",
    "json": "string",
    "log_filter": ["string"],
    "stackdriver": "string"
  },
  "max_session_expiry": 0,
  "max_token_lifetime": 0,
  "metrics_cache_refresh_interval": 0,
  "oauth2": {
    "github": {
      "allow_everyone": true,
      "allow_signups": true,
      "allowed_orgs": ["string"],
      "allowed_teams": ["string"],
      "client_id": "string",
      "client_secret": "string",
      "enterprise_base_url": "string"
    }
  },
  "oidc": {
    "allow_signups": true,
    "auth_url_params": {},
    "client_cert_file": "string",
    "client_id": "string",
    "client_key_file": "string",
    "client_secret": "string",
    "email_domain": ["string"],
    "email_field": "string",
    "group_allow_list": ["string"],
    "group_auto_create": true,
    "group_mapping": {},
    "group_regex_filter": {},
    "groups_field": "string",
    "icon_url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    },
    "ignore_email_verified": true,
    "ignore_user_info": true,
    "issuer_url": "string",
    "scopes": ["string"],
    "sign_in_text": "string",
    "user_role_field": "string",
    "user_role_mapping": {},
    "user_roles_default": ["string"],
    "username_field": "string"
  },
  "pg_connection_url": "string",
  "pprof": {
    "address": {
      "host": "string",
      "port": "string"
    },
    "enable": true
  },
  "prometheus": {
    "address": {
      "host": "string",
      "port": "string"
    },
    "collect_agent_stats": true,
    "collect_db_metrics": true,
    "enable": true
  },
  "provisioner": {
    "daemon_poll_interval": 0,
    "daemon_poll_jitter": 0,
    "daemon_psk": "string",
    "daemons": 0,
    "daemons_echo": true,
    "force_cancel_interval": 0
  },
  "proxy_health_status_interval": 0,
  "proxy_trusted_headers": ["string"],
  "proxy_trusted_origins": ["string"],
  "rate_limit": {
    "api": 0,
    "disable_all": true
  },
  "redirect_to_access_url": true,
  "scim_api_key": "string",
  "secure_auth_cookie": true,
  "ssh_keygen_algorithm": "string",
  "strict_transport_security": 0,
  "strict_transport_security_options": ["string"],
  "support": {
    "links": {
      "value": [
        {
          "icon": "string",
          "name": "string",
          "target": "string"
        }
      ]
    }
  },
  "swagger": {
    "enable": true
  },
  "telemetry": {
    "enable": true,
    "trace": true,
    "url": {
      "forceQuery": true,
      "fragment": "string",
      "host": "string",
      "omitHost": true,
      "opaque": "string",
      "path": "string",
      "rawFragment": "string",
      "rawPath": "string",
      "rawQuery": "string",
      "scheme": "string",
      "user": {}
    }
  },
  "tls": {
    "address": {
      "host": "string",
      "port": "string"
    },
    "allow_insecure_ciphers": true,
    "cert_file": ["string"],
    "client_auth": "string",
    "client_ca_file": "string",
    "client_cert_file": "string",
    "client_key_file": "string",
    "enable": true,
    "key_file": ["string"],
    "min_version": "string",
    "redirect_http": true,
    "supported_ciphers": ["string"]
  },
  "trace": {
    "capture_logs": true,
    "data_dog": true,
    "enable": true,
    "honeycomb_api_key": "string"
  },
  "update_check": true,
  "user_quiet_hours_schedule": {
    "default_schedule": "string"
  },
  "verbose": true,
  "web_terminal_renderer": "string",
  "wgtunnel_host": "string",
  "wildcard_access_url": {
    "forceQuery": true,
    "fragment": "string",
    "host": "string",
    "omitHost": true,
    "opaque": "string",
    "path": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "scheme": "string",
    "user": {}
  },
  "write_config": true
}

Properties

NameTypeRequiredRestrictionsDescription
access_urlclibase.URLfalse
addressclibase.HostPortfalseAddress Use HTTPAddress or TLS.Address instead.
agent_fallback_troubleshooting_urlclibase.URLfalse
agent_stat_refresh_intervalintegerfalse
autobuild_poll_intervalintegerfalse
browser_onlybooleanfalse
cache_directorystringfalse
configstringfalse
config_sshcodersdk.SSHConfigfalse
dangerouscodersdk.DangerousConfigfalse
derpcodersdk.DERPfalse
disable_owner_workspace_execbooleanfalse
disable_password_authbooleanfalse
disable_path_appsbooleanfalse
disable_session_expiry_refreshbooleanfalse
docs_urlclibase.URLfalse
enable_terraform_debug_modebooleanfalse
experimentsarray of stringfalse
external_authclibase.Struct-array_codersdk_ExternalAuthConfigfalse
external_token_encryption_keysarray of stringfalse
healthcheckcodersdk.HealthcheckConfigfalse
http_addressstringfalseHttp address is a string because it may be set to zero to disable.
in_memory_databasebooleanfalse
job_hang_detector_intervalintegerfalse
loggingcodersdk.LoggingConfigfalse
max_session_expiryintegerfalse
max_token_lifetimeintegerfalse
metrics_cache_refresh_intervalintegerfalse
oauth2codersdk.OAuth2Configfalse
oidccodersdk.OIDCConfigfalse
pg_connection_urlstringfalse
pprofcodersdk.PprofConfigfalse
prometheuscodersdk.PrometheusConfigfalse
provisionercodersdk.ProvisionerConfigfalse
proxy_health_status_intervalintegerfalse
proxy_trusted_headersarray of stringfalse
proxy_trusted_originsarray of stringfalse
rate_limitcodersdk.RateLimitConfigfalse
redirect_to_access_urlbooleanfalse
scim_api_keystringfalse
secure_auth_cookiebooleanfalse
ssh_keygen_algorithmstringfalse
strict_transport_securityintegerfalse
strict_transport_security_optionsarray of stringfalse
supportcodersdk.SupportConfigfalse
swaggercodersdk.SwaggerConfigfalse
telemetrycodersdk.TelemetryConfigfalse
tlscodersdk.TLSConfigfalse
tracecodersdk.TraceConfigfalse
update_checkbooleanfalse
user_quiet_hours_schedulecodersdk.UserQuietHoursScheduleConfigfalse
verbosebooleanfalse
web_terminal_rendererstringfalse
wgtunnel_hoststringfalse
wildcard_access_urlclibase.URLfalse
write_configbooleanfalse

codersdk.DisplayApp

"vscode"

Properties

Enumerated Values

Value
vscode
vscode_insiders
web_terminal
port_forwarding_helper
ssh_helper

codersdk.Entitlement

"entitled"

Properties

Enumerated Values

Value
entitled
grace_period
not_entitled

codersdk.Entitlements

{
  "errors": ["string"],
  "features": {
    "property1": {
      "actual": 0,
      "enabled": true,
      "entitlement": "entitled",
      "limit": 0
    },
    "property2": {
      "actual": 0,
      "enabled": true,
      "entitlement": "entitled",
      "limit": 0
    }
  },
  "has_license": true,
  "refreshed_at": "2019-08-24T14:15:22Z",
  "require_telemetry": true,
  "trial": true,
  "warnings": ["string"]
}

Properties

NameTypeRequiredRestrictionsDescription
errorsarray of stringfalse
featuresobjectfalse
» [any property]codersdk.Featurefalse
has_licensebooleanfalse
refreshed_atstringfalse
require_telemetrybooleanfalse
trialbooleanfalse
warningsarray of stringfalse

codersdk.Experiment

"moons"

Properties

Enumerated Values

Value
moons
workspace_actions
tailnet_pg_coordinator
single_tailnet
template_autostop_requirement
deployment_health_page
template_update_policies

codersdk.ExternalAuth

{
  "app_install_url": "string",
  "app_installable": true,
  "authenticated": true,
  "device": true,
  "display_name": "string",
  "installations": [
    {
      "account": {
        "avatar_url": "string",
        "login": "string",
        "name": "string",
        "profile_url": "string"
      },
      "configure_url": "string",
      "id": 0
    }
  ],
  "user": {
    "avatar_url": "string",
    "login": "string",
    "name": "string",
    "profile_url": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
app_install_urlstringfalseApp install URL is the URL to install the app.
app_installablebooleanfalseApp installable is true if the request for app installs was successful.
authenticatedbooleanfalse
devicebooleanfalse
display_namestringfalse
installationsarray of codersdk.ExternalAuthAppInstallationfalseInstallations are the installations that the user has access to.
usercodersdk.ExternalAuthUserfalseUser is the user that authenticated with the provider.

codersdk.ExternalAuthAppInstallation

{
  "account": {
    "avatar_url": "string",
    "login": "string",
    "name": "string",
    "profile_url": "string"
  },
  "configure_url": "string",
  "id": 0
}

Properties

NameTypeRequiredRestrictionsDescription
accountcodersdk.ExternalAuthUserfalse
configure_urlstringfalse
idintegerfalse

codersdk.ExternalAuthConfig

{
  "app_install_url": "string",
  "app_installations_url": "string",
  "auth_url": "string",
  "client_id": "string",
  "device_code_url": "string",
  "device_flow": true,
  "display_icon": "string",
  "display_name": "string",
  "extra_token_keys": ["string"],
  "id": "string",
  "no_refresh": true,
  "regex": "string",
  "scopes": ["string"],
  "token_url": "string",
  "type": "string",
  "validate_url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
app_install_urlstringfalse
app_installations_urlstringfalse
auth_urlstringfalse
client_idstringfalse
device_code_urlstringfalse
device_flowbooleanfalse
display_iconstringfalseDisplay icon is a URL to an icon to display in the UI.
display_namestringfalseDisplay name is shown in the UI to identify the auth config.
extra_token_keysarray of stringfalse
idstringfalseID is a unique identifier for the auth config. It defaults to type when not provided.
no_refreshbooleanfalse
regexstringfalseRegex allows API requesters to match an auth config by a string (e.g. coder.com) instead of by it's type.
Git clone makes use of this by parsing the URL from: 'Username for "https://github.com":' And sending it to the Coder server to match against the Regex.
scopesarray of stringfalse
token_urlstringfalse
typestringfalseType is the type of external auth config.
validate_urlstringfalse

codersdk.ExternalAuthDevice

{
  "device_code": "string",
  "expires_in": 0,
  "interval": 0,
  "user_code": "string",
  "verification_uri": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
device_codestringfalse
expires_inintegerfalse
intervalintegerfalse
user_codestringfalse
verification_uristringfalse
{
  "authenticated": true,
  "created_at": "2019-08-24T14:15:22Z",
  "expires": "2019-08-24T14:15:22Z",
  "has_refresh_token": true,
  "provider_id": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "validate_error": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
authenticatedbooleanfalse
created_atstringfalse
expiresstringfalse
has_refresh_tokenbooleanfalse
provider_idstringfalse
updated_atstringfalse
validate_errorstringfalse

codersdk.ExternalAuthUser

{
  "avatar_url": "string",
  "login": "string",
  "name": "string",
  "profile_url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
loginstringfalse
namestringfalse
profile_urlstringfalse

codersdk.Feature

{
  "actual": 0,
  "enabled": true,
  "entitlement": "entitled",
  "limit": 0
}

Properties

NameTypeRequiredRestrictionsDescription
actualintegerfalse
enabledbooleanfalse
entitlementcodersdk.Entitlementfalse
limitintegerfalse

codersdk.GenerateAPIKeyResponse

{
  "key": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
keystringfalse

codersdk.GetUsersResponse

{
  "count": 0,
  "users": [
    {
      "avatar_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "[email protected]",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_seen_at": "2019-08-24T14:15:22Z",
      "login_type": "",
      "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
      "roles": [
        {
          "display_name": "string",
          "name": "string"
        }
      ],
      "status": "active",
      "username": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
countintegerfalse
usersarray of codersdk.Userfalse

codersdk.GitSSHKey

{
  "created_at": "2019-08-24T14:15:22Z",
  "public_key": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
public_keystringfalse
updated_atstringfalse
user_idstringfalse

codersdk.Group

{
  "avatar_url": "string",
  "display_name": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "members": [
    {
      "avatar_url": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "[email protected]",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_seen_at": "2019-08-24T14:15:22Z",
      "login_type": "",
      "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
      "roles": [
        {
          "display_name": "string",
          "name": "string"
        }
      ],
      "status": "active",
      "username": "string"
    }
  ],
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "quota_allowance": 0,
  "source": "user"
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
display_namestringfalse
idstringfalse
membersarray of codersdk.Userfalse
namestringfalse
organization_idstringfalse
quota_allowanceintegerfalse
sourcecodersdk.GroupSourcefalse

codersdk.GroupSource

"user"

Properties

Enumerated Values

Value
user
oidc

codersdk.HealthSection

"DERP"

Properties

Enumerated Values

Value
DERP
AccessURL
Websocket
Database
WorkspaceProxy

codersdk.HealthSettings

{
  "dismissed_healthchecks": ["DERP"]
}

Properties

NameTypeRequiredRestrictionsDescription
dismissed_healthchecksarray of codersdk.HealthSectionfalse

codersdk.Healthcheck

{
  "interval": 0,
  "threshold": 0,
  "url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
intervalintegerfalseInterval specifies the seconds between each health check.
thresholdintegerfalseThreshold specifies the number of consecutive failed health checks before returning "unhealthy".
urlstringfalseURL specifies the endpoint to check for the app health.

codersdk.HealthcheckConfig

{
  "refresh": 0,
  "threshold_database": 0
}

Properties

NameTypeRequiredRestrictionsDescription
refreshintegerfalse
threshold_databaseintegerfalse

codersdk.InsightsReportInterval

"day"

Properties

Enumerated Values

Value
day
week

codersdk.IssueReconnectingPTYSignedTokenRequest

{
  "agentID": "bc282582-04f9-45ce-b904-3e3bfab66958",
  "url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
agentIDstringtrue
urlstringtrueURL is the URL of the reconnecting-pty endpoint you are connecting to.

codersdk.IssueReconnectingPTYSignedTokenResponse

{
  "signed_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
signed_tokenstringfalse

codersdk.JobErrorCode

"REQUIRED_TEMPLATE_VARIABLES"

Properties

Enumerated Values

Value
REQUIRED_TEMPLATE_VARIABLES

codersdk.License

{
  "claims": {},
  "id": 0,
  "uploaded_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Properties

NameTypeRequiredRestrictionsDescription
claimsobjectfalseClaims are the JWT claims asserted by the license. Here we use a generic string map to ensure that all data from the server is parsed verbatim, not just the fields this version of Coder understands.
idintegerfalse
uploaded_atstringfalse
uuidstringfalse

codersdk.LinkConfig

{
  "icon": "string",
  "name": "string",
  "target": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
iconstringfalse
namestringfalse
targetstringfalse

codersdk.LogLevel

"trace"

Properties

Enumerated Values

Value
trace
debug
info
warn
error

codersdk.LogSource

"provisioner_daemon"

Properties

Enumerated Values

Value
provisioner_daemon
provisioner

codersdk.LoggingConfig

{
  "human": "string",
  "json": "string",
  "log_filter": ["string"],
  "stackdriver": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
humanstringfalse
jsonstringfalse
log_filterarray of stringfalse
stackdriverstringfalse

codersdk.LoginType

""

Properties

Enumerated Values

Value
``
password
github
oidc
token
none

codersdk.LoginWithPasswordRequest

{
  "email": "[email protected]",
  "password": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
emailstringtrue
passwordstringtrue

codersdk.LoginWithPasswordResponse

{
  "session_token": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
session_tokenstringtrue

codersdk.MinimalUser

{
  "avatar_url": "http://example.com",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "username": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
avatar_urlstringfalse
idstringtrue
usernamestringtrue

codersdk.OAuth2Config

{
  "github": {
    "allow_everyone": true,
    "allow_signups": true,
    "allowed_orgs": ["string"],
    "allowed_teams": ["string"],
    "client_id": "string",
    "client_secret": "string",
    "enterprise_base_url": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
githubcodersdk.OAuth2GithubConfigfalse

codersdk.OAuth2GithubConfig

{
  "allow_everyone": true,
  "allow_signups": true,
  "allowed_orgs": ["string"],
  "allowed_teams": ["string"],
  "client_id": "string",
  "client_secret": "string",
  "enterprise_base_url": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
allow_everyonebooleanfalse
allow_signupsbooleanfalse
allowed_orgsarray of stringfalse
allowed_teamsarray of stringfalse
client_idstringfalse
client_secretstringfalse
enterprise_base_urlstringfalse

codersdk.OAuthConversionResponse

{
  "expires_at": "2019-08-24T14:15:22Z",
  "state_string": "string",
  "to_type": "",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
expires_atstringfalse
state_stringstringfalse
to_typecodersdk.LoginTypefalse
user_idstringfalse

codersdk.OIDCAuthMethod

{
  "enabled": true,
  "iconUrl": "string",
  "signInText": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
enabledbooleanfalse
iconUrlstringfalse
signInTextstringfalse

codersdk.OIDCConfig

{
  "allow_signups": true,
  "auth_url_params": {},
  "client_cert_file": "string",
  "client_id": "string",
  "client_key_file": "string",
  "client_secret": "string",
  "email_domain": ["string"],
  "email_field": "string",
  "group_allow_list": ["string"],
  "group_auto_create": true,
  "group_mapping": {},
  "group_regex_filter": {},
  "groups_field": "string",
  "icon_url": {
    "forceQuery": true,
    "fragment": "string",
    "host": "string",
    "omitHost": true,
    "opaque": "string",
    "path": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "scheme": "string",
    "user": {}
  },
  "ignore_email_verified": true,
  "ignore_user_info": true,
  "issuer_url": "string",
  "scopes": ["string"],
  "sign_in_text": "string",
  "user_role_field": "string",
  "user_role_mapping": {},
  "user_roles_default": ["string"],
  "username_field": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
allow_signupsbooleanfalse
auth_url_paramsobjectfalse
client_cert_filestringfalse
client_idstringfalse
client_key_filestringfalseClient key file & ClientCertFile are used in place of ClientSecret for PKI auth.
client_secretstringfalse
email_domainarray of stringfalse
email_fieldstringfalse
group_allow_listarray of stringfalse
group_auto_createbooleanfalse
group_mappingobjectfalse
group_regex_filterclibase.Regexpfalse
groups_fieldstringfalse
icon_urlclibase.URLfalse
ignore_email_verifiedbooleanfalse
ignore_user_infobooleanfalse
issuer_urlstringfalse
scopesarray of stringfalse
sign_in_textstringfalse
user_role_fieldstringfalse
user_role_mappingobjectfalse
user_roles_defaultarray of stringfalse
username_fieldstringfalse

codersdk.Organization

{
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringtrue
idstringtrue
namestringtrue
updated_atstringtrue

codersdk.OrganizationMember

{
  "created_at": "2019-08-24T14:15:22Z",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "roles": [
    {
      "display_name": "string",
      "name": "string"
    }
  ],
  "updated_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Properties

NameTypeRequiredRestrictionsDescription
created_atstringfalse
organization_idstringfalse
rolesarray of codersdk.Rolefalse
updated_atstringfalse
user_idstringfalse

codersdk.PatchGroupRequest

{
  "add_users": ["string"],
  "avatar_url": "string",
  "display_name": "string",
  "name": "string",
  "quota_allowance": 0,
  "remove_users": ["string"]
}