Skip to content

Authentication and execution settings

Choose one authentication method:

Method CLI option Required environment variables
Jira personal access token --api-key-auth XRAY_API_BASE_URL, XRAY_API_KEY
Basic authentication, if enabled by your administrator Neither auth flag XRAY_API_BASE_URL, XRAY_API_USER, XRAY_API_PASSWORD
Xray Cloud client credentials --cloud --client-secret-auth XRAY_API_BASE_URL, XRAY_CLIENT_ID, XRAY_CLIENT_SECRET

Cloud is a different service. It uses the Xray API base URL, /api/v2/authenticate and /api/v2/import/execution, with PASSED/FAILED status spelling. Server/DC uses PASS/FAIL. --cloud does not enable native iterations or change Test types. Cloud has synthetic test coverage, not live target validation.

TLS certificate verification is enabled by default. Set XRAY_API_VERIFY_SSL to True or to a trusted CA bundle path for an internal CA. False disables verification and should not be used with real credentials.

Optional execution metadata:

Environment variable Meaning
XRAY_EXECUTION_SUMMARY Execution title. A new execution defaults to Execution of automated tests.
XRAY_EXECUTION_DESC Execution description.
XRAY_EXECUTION_REVISION Revision, such as a commit ID.
XRAY_EXECUTION_TEST_ENVIRONMENTS Environment names separated by whitespace.
XRAY_EXECUTION_FIX_VERSION Fix version; the first nonempty parsed value is used.

These variables configure the legacy exporter; local case reporting does not need them. Secrets belong in your shell environment or protected CI settings, not test files or command-line arguments.