Organization
This endpoint is used to create, update, search or delete organizations information inside Terrakube.
The default group is handled using the Spring Boot property
org.azbuilder.owner=TERRAKUBE_ADMIN
Entity fields:
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
Returns the collection of type organization
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
GET /api/v1/organization HTTP/1.1
Host:
Accept: */*
Successful response
{
"data": [],
"included": [
{
"attributes": {},
"id": "text",
"relationships": {},
"type": "text"
}
]
}
Creates an item of type organization
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"
}
}
}
}
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"
}
}
}
}
Deletes an instance of type organization
organization Identifier
DELETE /api/v1/organization/{organizationId} HTTP/1.1
Host:
Accept: */*
Successful response
No content
Modifies an instance of type organization
organization Identifier
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"
}
}
}
}
Successful response
No content
Last updated
Was this helpful?