spotlight_team

The spotlight_team resource, and the team resource of the API: a group inside a workspace that holds lines, skills, harness profiles, integrations, hooks and chats.

KindEndpointTerraformAddress
team/api/resources/workspaces/{workspaceId}/teamsspotlight_team<key>

See Resource API for the operations, headers and errors every kind shares.

Example

resource "spotlight_team" "core" {
  workspace_id = spotlight_workspace.acme.id
  key          = "core"
  name         = "Core"
}

Fields

FieldTypeDefaultDescription
keystringrequiredNames the team within its workspace, and prefixes the address of everything it holds. Lowercase words joined by dashes, at most 64 characters. Fixed: an update that changes it is refused; Terraform replaces the resource.
namestringrequiredWhat the team is called. 1 to 100 characters.
workspaceIdstringread-onlyThe workspace that holds the team.

Rules

OperationRule
createNeeds configure. The team holds nothing.
updateNeeds configure. Changes name only.
deleteNeeds configure. Refused with 409 in-use while the team holds any line, skill, harness profile, integration or hook.
listEvery team of the workspace.
importGET /api/resources/workspaces/{workspaceId}/teams/import?address=<key>

An in-use refusal names what is left, as in Team core is not empty. Still holds: line delivery. See Roles and permissions for who holds each permission.

A team created through the resource API or Terraform has no lines. The first team of a workspace created in the web app starts with two; see A workspace created in the web app.

In Terraform

  • spotlight_team creates, changes and deletes a team. Its import id is <workspace id>/<key>.
  • The data source spotlight_team reads a team without managing it. See Provider.

On this page