Testkube Control Plane ../teams operations
Testkube Pro API (cloud-api/1.10.51)
Download OpenAPI specification:Download
E-mail: testkube@kubeshop.io License: COMMERICAL
API for Testkube Pro
List organization teams
Lists the teams in an organization.
Authorizations:
None
path Parameters
id required | string unique id of the object |
Responses
Response samples
- 200
- 401
- 403
Content type
application/json
[- {
- "id": "string",
- "slug": "string",
- "name": "string",
- "description": "string",
- "memberCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
Create a team
Creates a team.
Authorizations:
None
path Parameters
id required | string unique id of the object |
Request Body schema: application/jsonrequired
name required | string Display name of the team |
slug | string Human- and URL friendly identifier. |
description | string Description of the team |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "slug": "string",
- "description": "string"
}
Response samples
- 200
- 400
- 401
- 403
Content type
application/json
{- "id": "string",
- "slug": "string",
- "name": "string",
- "description": "string",
- "memberCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Get a team
Get a team by its id
or `slug.
Authorizations:
None
path Parameters
id required | string unique id of the object |
teamID required | string The identifier of this team |
Responses
Response samples
- 200
- 401
- 404
Content type
application/json
{- "id": "string",
- "slug": "string",
- "name": "string",
- "description": "string",
- "memberCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Delete a team
Deletes a team.
Authorizations:
None
path Parameters
id required | string unique id of the object |
teamID required | string The identifier of this team |
Responses
Response samples
- 401
- 403
- 404
Content type
application/problem+json
{- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
Update a team
Updates a team's information.
Authorizations:
None
path Parameters
id required | string unique id of the object |
teamID required | string The identifier of this team |
Request Body schema: application/jsonrequired
name | string Name of the team |
description | string Description of the team |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
Content type
application/json
{- "id": "string",
- "slug": "string",
- "name": "string",
- "description": "string",
- "memberCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Adds members to this team
Adds many members to this team.
Authorizations:
None
path Parameters
id required | string unique id of the object |
teamID required | string The identifier of this team |
Request Body schema: application/jsonrequired
users required | Array of strings The users to add to this environment. |
Responses
Request samples
- Payload
Content type
application/json
{- "users": [
- "string"
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
Content type
application/json
{- "users": [
- {
- "id": "string",
- "email": "string"
}
], - "failed": [
- "string"
]
}
Remove many members from this team
Remove many members from this team.
Authorizations:
None
path Parameters
id required | string unique id of the object |
teamID required | string The identifier of this team |
Request Body schema: application/jsonrequired
users required | Array of strings The users to remove from this team. |
Responses
Request samples
- Payload
Content type
application/json
{- "users": [
- "string"
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
Content type
application/json
{- "failed": [
- "string"
]
}