# Organization

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

{% hint style="info" %}
You need to be part of the administrator Active Directory Group to work with this endpoint
{% endhint %}

{% hint style="warning" %}
The default group is handled using the Spring Boot property

```
org.azbuilder.owner=TERRAKUBE_ADMIN
```

{% endhint %}

### 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

{% openapi src="<https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media>" path="/organization" method="get" %}
[v2\_1.yml](https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media)
{% endopenapi %}

{% openapi src="<https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media>" path="/organization" method="post" %}
[v2\_1.yml](https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media)
{% endopenapi %}

{% openapi src="<https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media>" path="/organization/{organizationId}" method="delete" %}
[v2\_1.yml](https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media)
{% endopenapi %}

{% openapi src="<https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media>" path="/organization/{organizationId}" method="patch" %}
[v2\_1.yml](https://2194998553-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR6VsmuTZWhfdwP7uD6e0%2Fuploads%2Fgit-blob-94a6d2f1f08b6f81f10e003e95530ac2a5b0b3f1%2Fv2_1.yml?alt=media)
{% endopenapi %}

{% hint style="info" %}
For a complete list of organization operation please visit the [OpenAPI specification](https://github.com/AzBuilder/terrakube-server/tree/main/openapi-spec)
{% endhint %}