Comment on page

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
/organization
post
/organization
delete
/organization/{organizationId}
patch
/organization/{organizationId}
For a complete list of organization operation please visit the OpenAPI specification​

Path	Type	Description
data.type	string	Should be "organization"
data.attributes.name	string	Unique name in Terrakube
data.attributes.description	string	Free description

Globalvar

Teams

Last modified 1mo ago