Configuring OIDC Connect (OAuth)

The OIDC (OAuth) authentication method is designed to configure the standard OAuth 2.0 flow, which requires the use of client or user secrets.

πŸ“˜

Note

Currently only the Customer Credentials and Resource Owner Password grant types of the OIDC are supported.

πŸ“˜

Note

This topic describes only how to fill in fields specific for OIDC connect (OAuth) (the Setup tab). For general steps, see Creating Authentication).

πŸ“˜

Note

Before following the instructions below, ensure that your application and authenticated resources are accessible to the Bright engine, either directly from the Internet or via the Repeater.

From the Authentication type dropdown list, select OpenID Connect (OAuth), and then proceed to the authentication details.

Authentication details

In this section, set up a valid authentication request to be sent to the end-point API by completing the provided fields.

15581558
FieldGuidelines
Discovery document URLProvide a discovery document URL (https://your_host/.well-known/openid-configuration) to populate endpoint URLs automatically or leave this field empty to enter endpoint URLs manually.
Grant typeFrom the drop-down list, select the grant type you need:
- Client Credentials Grant
- Resource Owner Password Grant

If you select the Resource Owner Password Grant, the Username and Password fields are added to the setup flow.
Token Endpoint Obtain an access and/or ID token by presenting an authorization grant or refresh token.
Client ID Enter your application client ID, unique client identifier preregistered in OpenID Provider.
Client Secret Enter your application client secret, used to authenticate to the Token Endpoint.
Username Enter the resource owner username.
Password Enter the resource owner password.
Scope(Optional) Enter a space-separated list of scopes.
Audience(Optional) Enter the intended recipient of the token.
Embed inSelect where to embed the token in the request.

- If the Default option is selected, the token is embedded according to the OIDC specification. For example, a token can be embedded in the authorization header with the Bearer prefix.
- If you select the Body option, specify the token encoder, content type, exact location in the body, and the token template string.
- If you select the Header option, specify the token encoder, the name of the target header, and the token template string.

Valid authentication response

In this section, select the options you want to use during the application scanning to determine that the authenticated resource has been reached. The options define how the application responds in case a full authentication flow passes successfully.

15601560
FieldGuidelines
Detect using Response STATUSEnter the HTTP response status that will tell you about the authentication success.
Detect using Response HEADER patternEnter the header name and Regex pattern that will help you identify the authentication success. For example, you can use a simple Regex pattern, such as index.
Detect using Response BODY patternEnter the body pattern that will help you identify the authentication success. For example, this Regex pattern detects a body looking for a UUID in a sessionId parameter: sessionId: \"\\b(uuid:){0,1}\\s_([a-f0-9\\-]_){1}\\s\*\".

πŸ“˜

Note

Bright allows testing a scan before saving it. For details, see the Testing Authentication.