Client Credentials Grant

The Client Credentials grant is one of the OAuth 2.0 grant types supported in ReadyAPI. Use this grant when a client application requests access to protected resources without user interaction.

To configure OAuth 2.0 authentication in ReadyAPI, see Enabling OAuth 2.0 Authentication. To configure the Client Credentials grant for applications in Azure Active Directory, see Enabling OAuth 2.0 Authentication with Azure Active Directory.

Table 52. Client Credentials Grant - Get Access Token dialog options

Options

Description

OAuth 2 Flow

Sets the OAuth 2.0 method to use.

Client Identification

An alphanumeric string that identifies the client.

Client Secret

The secret string the client uses.

Resource

(Azure only) The App ID URI of the web service.

Important

Microsoft Identity Platform v2.0 does not support this parameter.

Access Token URL

The URL to use to get an access token.

Audience

The URI that identifies the target resource or API the access token is intended for.

Apply Client JWT Assertion

Select to include a JSON Web Token (JWT) assertion in the authorization request.

Additional Parameters

Select to add custom name–value pairs to the OAuth 2.0 access token request body. ReadyAPI appends the parameters to the request and supports property expansion.

JWT Assertion

Is available if you selected Apply Client JWT Assertion.

Specifies the JWT included in the authorization request as a JWT assertion. Enter it manually or generate it.

Generate JWT

Click it to generate a JWT. The token is written to the JWT Assertion field. See Generating JSON Web Token. Available when you select Apply Client JWT Assertion.

Scope

The full scope string defining the requested permissions.

Use Nonce

Select to generate a unique string for each request. This lets the server verify that a request has not been made before and helps prevent replay attacks.

Use Authorization Header

Select to send client credentials in the request header. If not selected, credentials are sent in the request body.

Get Access Token

Click to retrieve the access token.

Automation

Click to open the Automated Token Profile editor.



See Also

Publication date: