Testkube Control Plane /users 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 users
List users
Authorizations:
None
query Parameters
limit | integer limit queries for list of resources |
Responses
Response samples
- 200
- 401
- 403
Content type
application/json
{- "elements": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "email": "nobody@kubeshop.io",
- "confirmed": true
}
]
}
Create new user
Create user
Authorizations:
None
Request Body schema: application/jsonrequired
environment details body
id required | string |
name required | string |
description | string |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
email required | string Users email |
confirmed required | boolean Does user confirmed email |
Responses
Request samples
- Payload
Content type
application/json
{- "id": "string",
- "name": "string",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "email": "nobody@kubeshop.io",
- "confirmed": true
}
Response samples
- 200
- 400
- 401
- 403
Content type
application/json
{- "id": "string",
- "name": "string",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "email": "nobody@kubeshop.io",
- "confirmed": true
}
Get user by ID
Get user by ID
Authorizations:
None
path Parameters
id required | string unique id of the object |
Responses
Response samples
- 200
- 401
- 403
Content type
application/json
{- "id": "string",
- "name": "string",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "email": "nobody@kubeshop.io",
- "confirmed": true
}
Update user
Update user with given request body
Authorizations:
None
path Parameters
id required | string unique id of the object |
Request Body schema: application/jsonrequired
environment details body
id required | string |
name required | string |
description | string |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
email required | string Users email |
confirmed required | boolean Does user confirmed email |
Responses
Request samples
- Payload
Content type
application/json
{- "id": "string",
- "name": "string",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "email": "nobody@kubeshop.io",
- "confirmed": true
}
Response samples
- 200
- 400
- 401
- 403
Content type
application/json
{- "id": "string",
- "name": "string",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "email": "nobody@kubeshop.io",
- "confirmed": true
}
User settings, global for Testkube Pro or Enterprise
Get API info like current version
path Parameters
id required | string unique id of the object |
Responses
Response samples
- 200
- 500
Content type
application/json
{- "elements": [
- {
- "key": "aiEnabled",
- "valueType": "boolean",
- "value": null,
- "organizationId": "string",
- "environmentId": "string",
- "userId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Update setting for given parameter
Update setting for given user
path Parameters
id required | string unique id of the object |
Request Body schema: application/jsonrequired
Settings upsert request
key required | string Enum: "aiEnabled" "logsSearchKeywords" "logsSearchKeywordsVersion" "webhookUrlMaskEnabled" "currentOnboardingStep" |
valueType required | string Enum: "boolean" "string" "number" "logsSearchKeywords" value type for given settings |
value | any (Any) |
organizationId | string |
environmentId | string |
userId | string |
updatedAt | string <date-time> |
Responses
Request samples
- Payload
Content type
application/json
{- "key": "aiEnabled",
- "valueType": "boolean",
- "value": null,
- "organizationId": "string",
- "environmentId": "string",
- "userId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 400
- 405
- 500
Content type
application/json
{- "key": "aiEnabled",
- "valueType": "boolean",
- "value": null,
- "organizationId": "string",
- "environmentId": "string",
- "userId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}