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

Example:

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

Supported Operations

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

PreviousGlobalvar NextTeams

Last updated 11 months ago

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();

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

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

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