Testkube Control Plane /users operations

• getList users
• postCreate new user
• getGet user by ID
• delDelete user
• patchUpdate user
• getUser settings, global for Testkube Pro or Enterprise
• patchUpdate setting for given parameter

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 users

List users

Authorizations:

None

query Parameters

limit

integer limit queries for list of resources

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/users

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users

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

required

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

Testkube Cloud API Endpoint

https://api.testkube.io/users

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users

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

Testkube Cloud API Endpoint

https://api.testkube.io/users/{id}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users/{id}

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

}

Delete user

Deletes user

Authorizations:

None

path Parameters

id required

string unique id of the object

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/users/{id}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users/{id}

Response samples

• 401
• 403

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 user

Update user with given request body

Authorizations:

None

path Parameters

id required

string unique id of the object

Request Body schema: application/json

required

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

Testkube Cloud API Endpoint

https://api.testkube.io/users/{id}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users/{id}

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

Testkube Cloud API Endpoint

https://api.testkube.io/users/{id}/settings

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users/{id}/settings

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

required

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

Testkube Cloud API Endpoint

https://api.testkube.io/users/{id}/settings

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/users/{id}/settings

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"

}