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

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

get

Returns an instance of type team

Path parameters
organizationIdstringRequired

organization Identifier

teamIdstringRequired

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": {
      "manageCollection": null,
      "manageJob": null,
      "manageModule": null,
      "manageProvider": null,
      "manageState": null,
      "manageTemplate": null,
      "manageVcs": null,
      "manageWorkspace": null,
      "name": null
    },
    "relationships": {
      "organization": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

For a complete list of organization operation please visit the OpenAPI specification

Last updated

Was this helpful?