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

get

Returns an instance of type team

Path parameters

organizationIdanyrequired

organization Identifier

teamIdanyrequired

team Identifier

Query parameters

fields[team]anyoptional

Selects the set of team fields that should be returned in the result.

includeanyoptional

Selects the set of relationships that should be expanded as a compound document in the result.

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organization/{organizationId}/team/{teamId}'

200

200

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

Successful response

post

Creates an item of type team and adds it to team

Path parameters

organizationIdanyrequired

organization Identifier

Body

dataobjectoptional

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organization/{organizationId}/team' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "type": "text",
      "id": "text",
      "attributes": {
        "manageModule": true,
        "manageProvider": true,
        "manageWorkspace": true,
        "name": "text"
      },
      "relationships": {
        "organization": {
          "id": "text",
          "type": "organization"
        }
      }
    }
  }'

201

201

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

Successful response

delete

Deletes an instance of type team

Path parameters

organizationIdanyrequired

organization Identifier

teamIdanyrequired

team Identifier

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/organization/{organizationId}/team/{teamId}'

204

204

No body

Successful response

patch

Modifies an instance of type team

Path parameters

organizationIdanyrequired

organization Identifier

teamIdanyrequired

team Identifier

Body

dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/organization/{organizationId}/team/{teamId}' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
    "data": {
      "type": "text",
      "id": "text",
      "attributes": {
        "manageModule": true,
        "manageProvider": true,
        "manageWorkspace": true,
        "name": "text"
      },
      "relationships": {
        "organization": {
          "id": "text",
          "type": "organization"
        }
      }
    }
  }'

204

204

No body

Successful response

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