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
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"
    }
  ]
}
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"
      }
    }
  }
}
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

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

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

Last updated

Was this helpful?