Testkube Control Plane ../groups operations

• getList organization groups
• postCreate a resource group
• getGet a resource group
• delDelete a resource group
• patchUpdate a resource group
• getLists all collaborators for this resource group
• postAdds all collaborators to this resource group
• delRemove many members from this group

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 groups

Lists the projects in an organization.

Authorizations:

None

path Parameters

id required

string unique id of the object

Responses

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

Response samples

• 200
• 401
• 403

Content type

application/json

[

• {

  • "id": "string",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "role": "string"

  }

]

Create a resource group

Creates a resource group.

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 resource group
slug	string Human- and URL friendly identifier.
description	string Description of the resource group

Responses

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

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",
• "createdAt": "2019-08-24T14:15:22Z",
• "updatedAt": "2019-08-24T14:15:22Z",
• "role": "string"

}

Get a resource group

Get a resource group by its id.

Authorizations:

None

path Parameters

id required	string unique id of the object
groupID required	string The identifier of this resource group

Responses

https://raw.githubusercontent.com/organizations/{id}/groups/{groupID}

Response samples

• 200
• 401
• 404

Content type

application/json

{

• "id": "string",
• "slug": "string",
• "name": "string",
• "description": "string",
• "createdAt": "2019-08-24T14:15:22Z",
• "updatedAt": "2019-08-24T14:15:22Z",
• "role": "string"

}

Delete a resource group

Deletes a resource group.

Authorizations:

None

path Parameters

id required	string unique id of the object
groupID required	string The identifier of this resource group

Responses

https://raw.githubusercontent.com/organizations/{id}/groups/{groupID}

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 resource group

Updates a resource groups information.

Authorizations:

None

path Parameters

id required	string unique id of the object
groupID required	string The identifier of this resource group

Request Body schema: application/json

required

name	string Name of the resource group
description	string Description of the resource group

Responses

https://raw.githubusercontent.com/organizations/{id}/groups/{groupID}

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",
• "createdAt": "2019-08-24T14:15:22Z",
• "updatedAt": "2019-08-24T14:15:22Z",
• "role": "string"

}

Lists all collaborators for this resource group

Lists all collaborators for this resource group.

Authorizations:

None

path Parameters

id required	string unique id of the object
groupID required	string The identifier of this resource group

Responses

https://raw.githubusercontent.com/organizations/{id}/groups/{groupID}/collaborators

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

[

• {

  • "kind": "string",
  • "id": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "role": "string",
  • "email": "string",
  • "slug": "string",
  • "memberCount": 0

  }

]

Adds all collaborators to this resource group

Adds all collaborators to this resource group.

Authorizations:

None

path Parameters

id required	string unique id of the object
groupID required	string The identifier of this resource group

Request Body schema: application/json

required

collaborators required	Array of strings The collaborators to add to this resource group.
role required	string The role to assign to all collaborators.

Responses

https://raw.githubusercontent.com/organizations/{id}/groups/{groupID}/collaborators

Request samples

• Payload

Content type

application/json

{

• "collaborators": [

  • "string"

  ],
• "role": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "collaborators": [

  • {

    • "kind": "string",
    • "id": "string",
    • "name": "string",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "role": "string",
    • "email": "string",
    • "slug": "string",
    • "memberCount": 0

    }

  ],
• "failed": [

  • "string"

  ]

}

Remove many members from this group

Remove many members from this access group.

Authorizations:

None

path Parameters

id required	string unique id of the object
groupID required	string The identifier of this resource group

Request Body schema: application/json

required

collaborators required

Array of strings The collaborators to remove from this group.

Responses

https://raw.githubusercontent.com/organizations/{id}/groups/{groupID}/collaborators

Request samples

• Payload

Content type

application/json

{

• "collaborators": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "failed": [

  • "string"

  ]

}