Testkube Control Plane ../members operations

• getGet environment members
• patchAdd member to environment
• delRemove user from environment
• patchUpdate env member role

API docs by Redocly

Testkube Pro API (cloud-api/1.10.38)

Download OpenAPI specification:Download

E-mail: testkube@kubeshop.io License: COMMERICAL

API for Testkube Pro

Get environment members

Get environment members

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/members

Response samples

• 200
• 401
• 403

Content type

application/json

[

• {

  • "email": "jack.the.ripper@testkube.io",
  • "status": "Invited",
  • "role": "read",
  • "inviteID": "1234567890-12312321-123123-3333",
  • "invitingEmail": "pikachu@testkube.io"

  }

]

Add member to environment

Add member to environment

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

Request Body schema: application/json

required

environment details body

Array

email required	string user email
status	string (MemberStatus) Enum: "Invited" "Accepted" "Rejected" "Revoked" Did Member confirmed organization subscription
role	string (EnvironmentRole) Enum: "read" "run" "write" "admin" "artifact"
inviteID	string Current Invite ID
invitingEmail	string Inviting user email

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/members

Request samples

• Payload

Content type

application/json

[

• {

  • "email": "jack.the.ripper@testkube.io",
  • "status": "Invited",
  • "role": "read",
  • "inviteID": "1234567890-12312321-123123-3333",
  • "invitingEmail": "pikachu@testkube.io"

  }

]

Response samples

• 200
• 400
• 401
• 402
• 403

Content type

application/json

[

• {

  • "email": "jack.the.ripper@testkube.io",
  • "status": "Invited",
  • "role": "read",
  • "inviteID": "1234567890-12312321-123123-3333",
  • "invitingEmail": "pikachu@testkube.io"

  }

]

Remove user from environment

Remove user from environment

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
memberEmail required	string unique email of the user

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/members/{memberEmail}

Response samples

• 400
• 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 env member role

Update env member role

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
memberEmail required	string unique email of the user

Request Body schema: application/json

required

environment details body

role required

string (EnvironmentRole) Enum: "read" "run" "write" "admin" "artifact"

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}/members/{memberEmail}

Request samples

• Payload

Content type

application/json

{

• "role": "read"

}

Response samples

• 200
• 400
• 401
• 402
• 403

Content type

application/json

{

• "email": "jack.the.ripper@testkube.io",
• "status": "Invited",
• "role": "read",
• "inviteID": "1234567890-12312321-123123-3333",
• "invitingEmail": "pikachu@testkube.io"

}