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

get

Returns the collection of type organization

Query parameters

filter[organization]stringOptional

Filters the collection of organization using a 'disjoint' RSQL expression

filterstringOptional

Filters the collection of organization using a 'joined' RSQL expression

page[number]integer · int32Optional

Number of pages to return. Can be used with page[size]

page[size]integer · int32Optional

Number of elements per page. Can be used with page[number]

page[offset]integer · int32Optional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer · int32Optional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses

200

Successful response

application/vnd.api+json

get

HTTPcURLJavaScriptPython

GET /api/v1/organization HTTP/1.1
Host: 
Accept: */*

200

Successful response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "description": null,
        "disabled": null,
        "executionMode": null,
        "icon": null,
        "name": null
      },
      "relationships": {
        "agent": {
          "data": [
            null
          ]
        },
        "collection": {
          "data": [
            null
          ]
        },
        "globalvar": {
          "data": [
            null
          ]
        },
        "job": {
          "data": [
            null
          ]
        },
        "module": {
          "data": [
            null
          ]
        },
        "provider": {
          "data": [
            null
          ]
        },
        "ssh": {
          "data": [
            null
          ]
        },
        "tag": {
          "data": [
            null
          ]
        },
        "team": {
          "data": [
            null
          ]
        },
        "template": {
          "data": [
            null
          ]
        },
        "vcs": {
          "data": [
            null
          ]
        },
        "workspace": {
          "data": [
            null
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

post

Creates an item of type organization

Body

Responses

201

Successful response

application/vnd.api+json

post

HTTPcURLJavaScriptPython

POST /api/v1/organization HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 375

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

201

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

delete

Deletes an instance of type organization

Path parameters

organizationIdanyRequired

organization Identifier

Responses

204

Successful response

No content

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/{organizationId} HTTP/1.1
Host: 
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type organization

Path parameters

organizationIdanyRequired

organization Identifier

Body

Responses

204

Successful response

No content

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/organization/{organizationId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 375

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

204

Successful response

No content

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