Terrakube
2.18.0
2.18.0
  • Introduction
  • Updates
  • Getting started
    • ๐Ÿ“Architecture
    • ๐Ÿ”Security
    • ๐Ÿš€Getting Started
    • ๐Ÿ’ฟDocker Images
    • ๐ŸŒDocker Compose
    • ๐Ÿ“ฅDeployment
      • ๐Ÿ”จHelm Chart
      • ๐Ÿš€Minikube
      • ๐Ÿ”‘Minikube + HTTPS
      • โœˆ๏ธIngress Configuration
      • ๐Ÿ”User Authentication (DEX)
      • ๐Ÿ’พStorage backend
        • Azure Storage Account
        • Amazon Cloud Storage
        • Google Cloud Storage
        • Minio (S3 compatible)
      • ๐Ÿ›ฐ๏ธDatabase Backend
        • SQL Azure
        • PostgreSQL
        • MySQL
        • H2
      • ๐Ÿ”Custom CA Certs
      • โš™๏ธCustom Terraform CLI Builds
      • ๐Ÿ›ก๏ธToken Security
      • ๐ŸšฆOpen Telemetry
    • ๐ŸคตUser Management
      • Azure Active Directory
      • Google Cloud Identity
      • Amazon Cognito
      • Github
  • ๐Ÿ““User Guide
    • Organizations
      • Creating an Organization
      • Global Variables
      • Team Management
      • API Tokens
      • Templates
        • Default Templates
        • Persistent Context
        • Import Templates
        • UI Templates
        • Filter gloval variables in jobs
        • Template Scheduling in Jobs
      • Tags
    • VCS Providers
      • Github
      • Github Enterprise
      • GitLab
      • Gitlab EE and CE
      • Bitbucket
      • Azure DevOps
      • SSH
    • Workspaces
      • Overview
      • Creating Workspaces
      • Terraform State
      • Share Workspace State
      • Variables
      • Workspace scheduler
      • API-driven Workflow
      • CLI-driven Workflow
      • Ephemeral Workspaces
    • Private Registry
      • Publishing Private Modules
      • Using Private Modules
    • Policy Enforcement (OPA)
    • Cost Estimation
    • Drift Detection
    • CI/CD Integration
      • Github Actions
      • Bitbucket
    • Terrakube CLI
      • Getting started
      • Installation
      • Commands
        • terrakube login
        • terrakube logout
        • terrakube organization
          • organization list
          • organization create
          • organization update
          • organization delete
        • terrakube team
          • team list
          • team create
          • team update
          • team delete
        • terrakube workspace
          • workspace list
          • workspace create
          • workspace update
          • workspace delete
          • workspace variable
            • variable list
        • terrakube variable
          • variable update
          • variable delete
          • variable create
        • terrakube job
          • job list
          • job create
        • terrakube module
          • module list
          • module create
          • module update
          • module delete
    • Reference
      • Executor
        • Terraform Execution Flow
        • Terraform Versions
    • Migrating to Terrakube
  • ๐ŸŽ“Learn
    • What is Terrakube
      • Section Overview
      • Terraform in a Nutshell
      • Terraform Challenges at Enterprise Level
      • Introducing Terrakube
      • Summary and Up Next
    • Deploying using Terrakube
  • ๐Ÿ“–API
    • ๐ŸŒŸGetting started
    • โš™๏ธMethods
      • Globalvar
      • Organization
      • Teams
      • Workspace
      • Variables
      • History
      • Jobs
      • Template
      • Schedule
      • Step
      • Module
      • Vcs
      • Provider
      • Personal Access Token
      • Team API Tokens
      • SSH Key
Powered by GitBook
On this page
  1. API
  2. Methods

Teams

This endpoint is used to create, update, search or delete teams information inside a Terrakube organization.

You need to be part of the administrator Active Directory Group to work with this endpoint

The default group is handled using the Spring Boot property

org.azbuilder.owner=TERRAKUBE_ADMIN

Entity fields:

Path
Type
Description

data.type

string

Should be "team"

data.attributes.name

string

Active Directory Group name

data.attributes.manageWorkspace

boolean

Enable Create/Update/Delete Workspaces for a Team

data.attributes.manageModule

boolean

Enable Create/Update/Delete Workspaces for a Team

data.attributes.manageProvider

boolean

Enable Create/Update/Delete Terraform Provider for a Team

data.attributes.manageVcs

boolean

Enable Create/Update/Delete VCS connection for private GIT Repositories for a Team

data.attributes.manageTemplates

boolean

Enable Create/Update/Delete Templates for a Team

Example:

{
  "data": {
    "type": "team",
    "attributes": {
      "name": "TERRAKUBE_TEAM",
      "manageWorkspace": true,
      "manageModule": true,
      "manageProvider": true,
      "manageVcs": true,
      "manageTemplate": true
    }
  }
}

Supported Operations

PreviousOrganizationNextWorkspace

Last updated 1 year ago

For a complete list of organization operation please visit the

๐Ÿ“–
โš™๏ธ
OpenAPI specification
get

Returns an instance of type team

Path parameters
organizationIdanyRequired

organization Identifier

teamIdanyRequired

team Identifier

Query parameters
Responses
200
Successful response
application/vnd.api+json
get
GET /api/v1/organization/{organizationId}/team/{teamId} HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "manageModule": true,
      "manageProvider": true,
      "manageWorkspace": true,
      "name": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  },
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}
delete

Deletes an instance of type team

Path parameters
organizationIdanyRequired

organization Identifier

teamIdanyRequired

team Identifier

Responses
204
Successful response
delete
DELETE /api/v1/organization/{organizationId}/team/{teamId} HTTP/1.1
Host: 
Accept: */*
204

Successful response

No content

  • Entity fields:
  • Example:
  • Supported Operations
  • GET/organization/{organizationId}/team/{teamId}
  • POST/organization/{organizationId}/team
  • DELETE/organization/{organizationId}/team/{teamId}
  • PATCH/organization/{organizationId}/team/{teamId}
post

Creates an item of type team and adds it to team

Path parameters
organizationIdanyRequired

organization Identifier

Body
Responses
201
Successful response
application/vnd.api+json
post
POST /api/v1/organization/{organizationId}/team HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 199

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "manageModule": true,
      "manageProvider": true,
      "manageWorkspace": true,
      "name": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}
201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "manageModule": true,
      "manageProvider": true,
      "manageWorkspace": true,
      "name": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}
patch

Modifies an instance of type team

Path parameters
organizationIdanyRequired

organization Identifier

teamIdanyRequired

team Identifier

Body
Responses
204
Successful response
patch
PATCH /api/v1/organization/{organizationId}/team/{teamId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 199

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "manageModule": true,
      "manageProvider": true,
      "manageWorkspace": true,
      "name": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}
204

Successful response

No content