Xray Credentials

What is this feature?

This feature is a secure configuration page used to store the Client ID and Client secret for the Xray Test Management app. These credentials are used to authenticate the Revyz application with the Xray API, granting it permission to access your test-related data.

What is the use case?

The use case is to enable the backup of your third-party Xray data. Standard Jira backups do not include this data, so an administrator must provide these credentials to allow Revyz to access and back up all critical test artifacts, such as test plans, test cases, and execution results.

Configuring Xray Credentials for Backup

The Xray Credentials page is a critical configuration step to ensure that all your Xray Test Management data is successfully included in your Revyz backups.

This setting allows you to securely store the API credentials (a Client ID and Client Secret) that Revyz needs to access and back up your Xray data.

Why Are Xray Credentials Required?

Xray (a third-party app) stores its data, such as Test Cases, Test Plans, and Test Executions, and protects it using its own REST API. To back up this specialized data, Revyz must authenticate itself to the Xray application.

• Authentication: The Client ID and Client secret act as a secure username and password for the API.

• Access: Providing valid credentials grants Revyz the necessary permission to interact with the Xray API and request a complete copy of your test management data for backup. Without these keys, the backup job will not be able to access and will skip all Xray data.

How to Obtain Xray Credentials

You must generate the Client ID and Client secret from within the Xray app's configuration in Jira.

1. Log in to your Jira instance as a Jira Administrator.

2. Navigate to Jira Settings (the cog icon ⚙️ in the top right).

3. Select Apps from the settings menu.

4. In the left-hand sidebar, find the XRAY section and click on API Keys.

5. Search for the user you want to generate the API keys for.

   Best Practice: We strongly recommend creating a dedicated service account (e.g., "revyz-backup-user") in Jira for this purpose. Using a personal admin account can cause the backup to fail if that user's account is deactivated or their permissions change.

6. Click the "Generate" or "Create API Key" button for that user.

7. Xray will generate a Client ID and a Client secret.

8. Copy both of these values immediately and store them securely (like in a password manager). You will need them for the next step.

How to Configure Credentials in Revyz

Once you have your Xray credentials, you can enter them into the Revyz Command Center.

1. On the Xray Credentials page (as shown in the screenshot), click the Edit button in the top-right corner of the form.

2. Paste the Client ID you copied from Xray into the Client ID * field.

3. Paste the Client secret you copied from Xray into the Client secret * field.

4. Click Save to store the credentials.

Revyz will then use these credentials for all future backup jobs to securely connect to Xray and back up your test management data.