OpenID Connect

OpenID Connect is an extension of the OAuth 2.0 framework. Client applications use it to verify a user's identity through the authorization server. The authorization server performs the authentication and returns an ID token - encoded information about the user.

Configure OpenID Connect

To configure OpenID Connect, follow these steps:

  1. Create an OAuth 2.0 or OAuth 2.0 (Azure) authorization profile.

  2. Click Get ID Token in ID Token (Optional):

    Auth Manager
    The Auth Manager dialog in ReadyAPI showing the Profile parameters tab with the Get ID Token button highlighted in the ID Token (Optional) section, alongside the Access Token field and Get Access Token button.
    Auth Panel
    The Auth panel in ReadyAPI showing an OAuth 2.0 Profile selected in the Authorization dropdown, with the Get ID Token button highlighted in the ID Token (Optional) section, alongside the Access Token field and Get Access Token expander.

  3. Select the needed authentication grant type and configure the request. The following topics describe the corresponding settings:

How to use ID token

ReadyAPI stores the ID token in the authorization profile object. To get the token value, use the following Groovy script:

Groovy
// Get the authorization profile
def authEntry =
  context.testCase.testSuite.project.getAuthRepository().getEntry("OAuth Profile Name");

// Get the ID token
def idToken = authEntry.getIdToken();

// Save the ID token as the result of the Groovy test step
return idToken;

Then use the property expansions to insert the token wherever you need. For example, if you get the ID token in the Get ID Token test step, use the following property expansion to retrieve it:

${Get ID Token#result}

See Also

In this section:
© 2026
Publication date: