Testkube Control Plane ../teams operations

• getList organization teams
• postCreate a team
• getGet a team
• delDelete a team
• patchUpdate a team
• getLists all members for this team
• postAdds members to this team
• delRemove many members from this team

API docs by Redocly

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

https://raw.githubusercontent.com/organizations/{id}/teams

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/json

required

name required	string Display name of the team
slug	string Human- and URL friendly identifier.
description	string Description of the team

Responses

https://raw.githubusercontent.com/organizations/{id}/teams

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

https://raw.githubusercontent.com/organizations/{id}/teams/{teamID}

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

https://raw.githubusercontent.com/organizations/{id}/teams/{teamID}

Response samples

• 401
• 403
• 404

Content type

application/problem+json

{

• "type": "https://kubeshop.io/testkube/problems/invalidtestname",
• "title": "Invalid test name",
• "status": 500,
• "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
• "instance": "http://10.23.23.123:8088/tests"

}

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/json

required

name	string Name of the team
description	string Description of the team

Responses

https://raw.githubusercontent.com/organizations/{id}/teams/{teamID}

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"

}

Lists all members for this team

Lists all members for this team.

Authorizations:

None

path Parameters

id required	string unique id of the object
teamID required	string The identifier of this team

Responses

https://raw.githubusercontent.com/organizations/{id}/teams/{teamID}/members

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

[

• {

  • "id": "string",
  • "email": "string"

  }

]

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/json

required

users required

Array of strings The users to add to this environment.

Responses

https://raw.githubusercontent.com/organizations/{id}/teams/{teamID}/members

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/json

required

users required

Array of strings The users to remove from this team.

Responses

https://raw.githubusercontent.com/organizations/{id}/teams/{teamID}/members

Request samples

• Payload

Content type

application/json

{

• "users": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "failed": [

  • "string"

  ]

}