Organization

This endpoint is used to create, update, search or delete organizations information inside Terrakube.

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 "organization"
data.attributes.name	string	Unique name in Terrakube
data.attributes.description	string	Free description

Example:

{
  "data": {
    "type": "organization",
    "attributes": {
      "name": "terrakube",
      "description": "Terrakube Organization"
    }
  }
}

Supported Operations

Returns the collection of type organization

GET/api/v1/organization

Query parameters

Response

200

Successful response

Body

application/vnd.api+json

dataarray of organization (object)

includedarray of object

Included resources

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "description": "text",
        "name": "text"
      },
      "relationships": {
        "job": {
          "id": "text",
          "type": "job"
        },
        "module": {
          "id": "text",
          "type": "module"
        },
        "provider": {
          "id": "text",
          "type": "provider"
        },
        "team": {
          "id": "text",
          "type": "team"
        },
        "template": {
          "id": "text",
          "type": "template"
        },
        "vcs": {
          "id": "text",
          "type": "vcs"
        },
        "workspace": {
          "id": "text",
          "type": "workspace"
        }
      }
    }
  ],
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

Creates an item of type organization

POST/api/v1/organization

Body

application/vnd.api+json

dataorganization (object)

Response

201

Successful response

Body

application/vnd.api+json

dataorganization (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "description": "text",
      "name": "text"
    },
    "relationships": {
      "job": {
        "id": "text",
        "type": "job"
      },
      "module": {
        "id": "text",
        "type": "module"
      },
      "provider": {
        "id": "text",
        "type": "provider"
      },
      "team": {
        "id": "text",
        "type": "team"
      },
      "template": {
        "id": "text",
        "type": "template"
      },
      "vcs": {
        "id": "text",
        "type": "vcs"
      },
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

Deletes an instance of type organization

DELETE/api/v1/organization/{organizationId}

Path parameters

organizationId*string

organization Identifier

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Modifies an instance of type organization

PATCH/api/v1/organization/{organizationId}

Path parameters

organizationId*string

organization Identifier

Body

application/vnd.api+json

dataorganization (object)

Response

204

Successful response

Request

JavaScriptCurl

const response = await fetch('/api/v1/organization/{organizationId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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