Page tree

You are on the Xray Cloud documentation. If you are looking for Xray Server documentation, you can find it in this page

Skip to end of metadata
Go to start of metadata

In this page, the administrator can manage API keys that can be used in order to interact with Xray using its REST API.

An API key may be created for each Jira user. Each API key contains a Client Id and a Client Secret which can be used during the authentication phase.

From thereon, authenticated REST API requests will be done in behalf of the user linked to the API key being used



Single operations

Create an API Key

  1. Click the Create API Key button.
  2. Select the user and click Generate.
  3. If no API Key already exists for that user, a new API Key will be created and linked to that user. A Client Id and a Client Secret will be generated, which can then be used for authenticaiton purposes.

Delete an API Key

  1. Click on the action icon on the right of the table entry. Choose Delete.
  2. Confirm by clicking Delete.

Regenerate Client Secret

  1. Click on the action icon on the right of the table entry. Choose Regenerate Client Secret.
  2. Click Confirm in the confirmation dialog.

Bulk operations

Select API Keys

Bulk selection of API Keys can be achieved either from the top picker or by individually checking the API Keys within the table.

   


Whenever API Keys are selected, an action button near the bulk selection icon will list the available bulk actions.


Delete API Keys

Multiple API Keys may be deleted as follows:

  1. Select one or more API Keys, either by using the bulk action icon or by individually checking the API Keys within the table
  2. In the button that shows the number of selected API Keys, click Delete.
  3. Confirm by clicking Delete.

Regenerate Client Secret

The Client Secret of multiple API Keys may be regenerated as follows:

  1. Select one or more API Keys, either by using the bulk action icon or by individually checking the API Keys within the table
  2. In the button that shows the number of selected API Keys, click Regenerate Client Secret.
  3. Click Confirm.

  • No labels