Testkube Control Plane ../groups operations
Testkube Pro API (cloud-api/1.10.51)
Download OpenAPI specification:Download
API for Testkube Pro
List organization groups
Lists the projects in an organization.
Authorizations:
path Parameters
id required | string unique id of the object |
Responses
Response samples
- 200
- 401
- 403
[- {
- "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:
path Parameters
id required | string unique id of the object |
Request Body schema: application/jsonrequired
name required | string Display name of the resource group |
slug | string Human- and URL friendly identifier. |
description | string Description of the resource group |
Responses
Request samples
- Payload
{- "name": "string",
- "slug": "string",
- "description": "string"
}
Response samples
- 200
- 400
- 401
- 403
{- "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:
path Parameters
id required | string unique id of the object |
groupID required | string The identifier of this resource group |
Responses
Response samples
- 200
- 401
- 404
{- "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:
path Parameters
id required | string unique id of the object |
groupID required | string The identifier of this resource group |
Responses
Response samples
- 401
- 403
- 404
{- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
Update a resource group
Updates a resource groups information.
Authorizations:
path Parameters
id required | string unique id of the object |
groupID required | string The identifier of this resource group |
Request Body schema: application/jsonrequired
name | string Name of the resource group |
description | string Description of the resource group |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "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:
path Parameters
id required | string unique id of the object |
groupID required | string The identifier of this resource group |
Responses
Response samples
- 200
- 401
- 403
- 404
[- {
- "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:
path Parameters
id required | string unique id of the object |
groupID required | string The identifier of this resource group |
Request Body schema: application/jsonrequired
collaborators required | Array of strings The collaborators to add to this resource group. |
role required | string The role to assign to all collaborators. |
Responses
Request samples
- Payload
{- "collaborators": [
- "string"
], - "role": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "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:
path Parameters
id required | string unique id of the object |
groupID required | string The identifier of this resource group |
Request Body schema: application/jsonrequired
collaborators required | Array of strings The collaborators to remove from this group. |
Responses
Request samples
- Payload
{- "collaborators": [
- "string"
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "failed": [
- "string"
]
}