Activate ReadyAPI on Headless Machines and in CI/CD

Important

A Floating license is required for all headless and CI/CD use. Fixed (Named) licenses cannot run Test Runners and fail silently in pipeline environments.

Choose your path

Before configuring your pipeline, confirm which scenario applies:

Private network path

If your build environment cannot reach the SmartBear-hosted servers, complete the following steps and then configure authentication using one of the approaches below.

  1. Set up an On-Premises License Server and convert your Floating license to an offline license. See Licenses in Private Networks.

  2. Assign the license to the service account or user running headless tests through the on-premises portal.

Access for Everyone flag

If you enable Access for Everyone on SmartBear License Management (SLM) on-premises, you do not need to add Access Key credentials on the command line. Add the following flag to your command-line interface (CLI) command:

-D licenseApiAccessForEveryone=true

Access Key

Add the license Access Key as a parameter on the command line. Use the -accessKey parameter (or -K for short).

Client Credentials (Open ID Connect)

Once the SLM On-Premises License Server is configured for Open ID Connect (OIDC) and the correct license is assigned to the test user, configure the test runners using your credentials:

  • --clientId or -ci <Client ID>: specifies the Client ID for the SLM On-Premises License Server.

  • --clientSecret or -cs <Client Secret>: specifies the Client Secret for the SLM On-Premises License Server.

For instructions on configuring SLM on-premises for OIDC and accessing credentials, see Configure On-Premise License Manager.

Note

You can authenticate using the username and password for your on-premises Lightweight Directory Access Protocol (LDAP) configuration; not SmartBear-hosted credentials.

Important

Offline Fixed (Named) licenses cannot run Test Runners. Only offline Floating licenses support CI/CD and headless use in private network environments.

Docker

When using the ReadyAPI Docker image, pass credentials using environment variables.

Access Key

docker run ... \
  -e SLM_LICENSE_SERVER="<on-prem-server-address>" \
  -e API_KEY="<your-access-key>"

Client Credentials (on-premises OIDC, SLM on-premises 2.0 or later)

docker run ... \
  -e SLM_LICENSE_SERVER="<on-prem-server-address>" \
  -e CLIENT_ID="<client-id>" \
  -e CLIENT_SECRET="<client-secret>"

Important

A Floating license is required for all Docker use. Fixed (Named) licenses are not supported in Docker environments.

See Also

Publication date: