Teams
This endpoint is used to create, update, search or delete teams information inside a Terrakube organization.
The default group is handled using the Spring Boot property
org.azbuilder.owner=TERRAKUBE_ADMIN
Entity fields:
data.type
string
Should be "team"
data.attributes.name
string
Active Directory Group name
data.attributes.manageWorkspace
boolean
Enable Create/Update/Delete Workspaces for a Team
data.attributes.manageModule
boolean
Enable Create/Update/Delete Workspaces for a Team
data.attributes.manageProvider
boolean
Enable Create/Update/Delete Terraform Provider for a Team
data.attributes.manageVcs
boolean
Enable Create/Update/Delete VCS connection for private GIT Repositories for a Team
data.attributes.manageTemplates
boolean
Enable Create/Update/Delete Templates for a Team
Example:
{
"data": {
"type": "team",
"attributes": {
"name": "TERRAKUBE_TEAM",
"manageWorkspace": true,
"manageModule": true,
"manageProvider": true,
"manageVcs": true,
"manageTemplate": true
}
}
}
Supported Operations
Returns an instance of type team
organization Identifier
team Identifier
GET /api/v1/organization/{organizationId}/team/{teamId} HTTP/1.1
Host:
Accept: */*
Successful response
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"manageModule": true,
"manageProvider": true,
"manageWorkspace": true,
"name": "text"
},
"relationships": {
"organization": {
"id": "text",
"type": "organization"
}
}
},
"included": [
{
"attributes": {},
"id": "text",
"relationships": {},
"type": "text"
}
]
}
Creates an item of type team and adds it to team
organization Identifier
POST /api/v1/organization/{organizationId}/team HTTP/1.1
Host:
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 199
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"manageModule": true,
"manageProvider": true,
"manageWorkspace": true,
"name": "text"
},
"relationships": {
"organization": {
"id": "text",
"type": "organization"
}
}
}
}
Successful response
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"manageModule": true,
"manageProvider": true,
"manageWorkspace": true,
"name": "text"
},
"relationships": {
"organization": {
"id": "text",
"type": "organization"
}
}
}
}
Deletes an instance of type team
organization Identifier
team Identifier
DELETE /api/v1/organization/{organizationId}/team/{teamId} HTTP/1.1
Host:
Accept: */*
Successful response
No content
Modifies an instance of type team
organization Identifier
team Identifier
PATCH /api/v1/organization/{organizationId}/team/{teamId} HTTP/1.1
Host:
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 199
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"manageModule": true,
"manageProvider": true,
"manageWorkspace": true,
"name": "text"
},
"relationships": {
"organization": {
"id": "text",
"type": "organization"
}
}
}
}
Successful response
No content
Last updated
Was this helpful?