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
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
data.type
string
Should be "organization"
data.attributes.name
string
Unique name in Terrakube
data.attributes.description
string
Free description
Deletes an instance of type organization
organization Identifier
Successful response
Modifies an instance of type organization
organization Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Successful response
Creates an item of type organization
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Returns the collection of type organization
Sorts the collection on the selected attributes. A prefix of '-' sorts descending
Selects the set of organization fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Filters the collection of organization using a 'disjoint' RSQL expression
Filters the collection of organization using a 'joined' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Included resources