AuthApiHelper

The AuthApiHelper class retrieves authentication tokens from a running RHDH instance via its auth API. It uses an existing Playwright Page to make authenticated requests, which means it works within the context of a test that has already navigated to RHDH.

Importing

import { AuthApiHelper } from '@red-hat-developer-hub/e2e-test-utils/helpers';

Setup

AuthApiHelper requires a Playwright Page object. Create an instance after navigating to RHDH and completing login:

import { test } from '@red-hat-developer-hub/e2e-test-utils/test';
import { AuthApiHelper } from '@red-hat-developer-hub/e2e-test-utils/helpers';

test('example', async ({ page }) => {
  const authApiHelper = new AuthApiHelper(page);
});

Methods

getToken(provider?, environment?)

Fetches a Backstage identity token from the RHDH auth refresh endpoint.

async getToken(
  provider: string = "oidc",
  environment: string = "production"
): Promise<string>

Parameters

Parameter	Type	Default	Description
provider	string	"oidc"	The auth provider configured in RHDH (e.g. "oidc", "github")
environment	string	"production"	The auth environment to use (e.g. "production", "development")

Returns Promise<string> — the Backstage identity token from backstageIdentity.token.

Throws if the HTTP request fails or if the token is not found in the response body.

// Using defaults (OIDC provider, production environment)
const token = await authApiHelper.getToken();

// Using a custom provider
const token = await authApiHelper.getToken('github');

// Using a custom provider and environment
const token = await authApiHelper.getToken('oidc', 'development');

Error Handling

getToken throws on HTTP errors or if the token is missing from the response body. Wrap calls in a try/catch when you need to handle failures gracefully:

try {
  const token = await authApiHelper.getToken();
} catch (error) {
  console.error('Could not retrieve auth token:', error);
  throw error;
}

Environment Variables

AuthApiHelper does not read any environment variables directly. The Page instance used to construct it should already be pointing at the correct RHDH base URL (set via RHDH_BASE_URL or your Playwright baseURL config).

Related Pages

• RbacApiHelper — uses tokens obtained from AuthApiHelper
• LoginHelper — authenticates the browser session before calling getToken
• APIHelper — catalog and GitHub API operations
• Common Patterns — example of using getToken with RbacApiHelper