Testkube Control Plane ../invites operations

• getList organization invites
• postInvite users to the organization
• getGet organization invite
• patchUpdates an organization invite
• postResend organization invite
• postRevoke organization invite

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 invites

Lists all invites for an organization.

Authorizations:

None

path Parameters

id required

string unique id of the object

query Parameters

status

string Enum: "pending" "revoked" "accepted" "declined" "failed" The status of the invites.

Responses

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

Response samples

• 200
• 401
• 403

Content type

application/json

[

• {

  • "id": "string",
  • "organization": "string",
  • "status": "pending",
  • "email": "string",
  • "inviter": "string",
  • "token": "string",
  • "role": "string",
  • "envRole": "string",
  • "envs": [

    • "string"

    ],
  • "teams": [

    • "string"

    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "revokedAt": "2019-08-24T14:15:22Z",
  • "acceptedAt": "2019-08-24T14:15:22Z",
  • "declinedAt": "2019-08-24T14:15:22Z"

  }

]

Invite users to the organization

Invites one or more users to this organization.

Authorizations:

None

path Parameters

id required

string unique id of the object

Request Body schema: application/json

required

emails required	Array of strings Email of the invitee.
role	string The role that will be assigned to the person after accepting.
teams	Array of strings Teams which the person will get access to after accepting the invite.
envs	Array of strings Environments which the person will get access to after accepting the invite.
envRole	string The role that will be assigned to the person's environments after accepting.

Responses

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

Request samples

• Payload

Content type

application/json

{

• "emails": [

  • "string"

  ],
• "role": "string",
• "teams": [

  • "string"

  ],
• "envs": [

  • "string"

  ],
• "envRole": "string"

}

Response samples

• 200
• 400
• 401
• 403

Content type

application/json

{

• "invites": [

  • {

    • "id": "string",
    • "organization": "string",
    • "status": "pending",
    • "email": "string",
    • "inviter": "string",
    • "token": "string",
    • "role": "string",
    • "envRole": "string",
    • "envs": [

      • "string"

      ],
    • "teams": [

      • "string"

      ],
    • "createdAt": "2019-08-24T14:15:22Z",
    • "updatedAt": "2019-08-24T14:15:22Z",
    • "expiresAt": "2019-08-24T14:15:22Z",
    • "revokedAt": "2019-08-24T14:15:22Z",
    • "acceptedAt": "2019-08-24T14:15:22Z",
    • "declinedAt": "2019-08-24T14:15:22Z"

    }

  ],
• "failed": [

  • "string"

  ]

}

Get organization invite

Get an invite for an organization with given id.

Authorizations:

None

path Parameters

id required	string unique id of the object
inviteID required	string unique invite ID

Responses

https://raw.githubusercontent.com/organizations/{id}/invites/{inviteID}

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "organization": "string",
• "status": "pending",
• "email": "string",
• "inviter": "string",
• "token": "string",
• "role": "string",
• "envRole": "string",
• "envs": [

  • "string"

  ],
• "teams": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "updatedAt": "2019-08-24T14:15:22Z",
• "expiresAt": "2019-08-24T14:15:22Z",
• "revokedAt": "2019-08-24T14:15:22Z",
• "acceptedAt": "2019-08-24T14:15:22Z",
• "declinedAt": "2019-08-24T14:15:22Z"

}

Updates an organization invite

Updates an organization invite.

Authorizations:

None

path Parameters

id required	string unique id of the object
inviteID required	string unique invite ID

Request Body schema: application/json

required

role	string The role that will be assigned to the person after accepting.
teams	Array of strings Teams which the person will get access to after accepting the invite.
envs	Array of strings Environments which the person will get access to after accepting the invite.
envRole	string The role that will be assigned to the person's environments after accepting.

Responses

https://raw.githubusercontent.com/organizations/{id}/invites/{inviteID}

Request samples

• Payload

Content type

application/json

{

• "role": "string",
• "teams": [

  • "string"

  ],
• "envs": [

  • "string"

  ],
• "envRole": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "id": "string",
• "organization": "string",
• "status": "pending",
• "email": "string",
• "inviter": "string",
• "token": "string",
• "role": "string",
• "envRole": "string",
• "envs": [

  • "string"

  ],
• "teams": [

  • "string"

  ],
• "createdAt": "2019-08-24T14:15:22Z",
• "updatedAt": "2019-08-24T14:15:22Z",
• "expiresAt": "2019-08-24T14:15:22Z",
• "revokedAt": "2019-08-24T14:15:22Z",
• "acceptedAt": "2019-08-24T14:15:22Z",
• "declinedAt": "2019-08-24T14:15:22Z"

}

Resend organization invite

Resend an invite for an organization with given id.

Authorizations:

None

path Parameters

id required	string unique id of the object
inviteID required	string unique invite ID

Responses

https://raw.githubusercontent.com/organizations/{id}/invites/{inviteID}/resend

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"

}

Revoke organization invite

Revoke an invite for an organization with given id.

Authorizations:

None

path Parameters

id required	string unique id of the object
inviteID required	string unique invite ID

Responses

https://raw.githubusercontent.com/organizations/{id}/invites/{inviteID}/revoke

Response samples

• 400
• 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"

}