Configuring an OAuth 2.0 Provider data instance

Complete the OAuth 2.0 Provider tab to specify the configuration details that are required to connect to an external application by using OAuth 2.0. Consult the API guide of the external application to learn how to obtain the values that are required for the fields on this form.

Basic information

Enter the basic details for the OAuth 2.0 provider.

Field Description
Grant types Select a grant type for the OAuth 2.0 Provider data instance. Select from the following:
  • Client credentials
  • Authorization code
  • Password credentials
Authorization code endpoint Enter the authorization code endpoint URL that is specified in the API guide of the application that you want to connect to. Calls to this endpoint produce an access token that you can use to access protected resources in the external application for a defined period of time.
Access token endpoint Required. Enter the access token URL that is specified in the API guide of the application that you want to connect to. Calls to this endpoint produce an access token that you can use to access protected resources in the external application for a defined period of time.
Revoke token endpoint Enter the revoke token URL that is specified in the API guide of the application that you want to connect to. Calls to this endpoint revoke issued access tokens.
Client authentication scheme Select how to send the client credentials. Choose either:
  • Basic – Send the client credentials (client ID and client secret) to the external application as a part of the Authorization header.
  • POST – Send the client credentials in the body of the POST request.
Send access token as Select whether you want to send the access token to the external application. Choose either:
  • Authorization header
  • Query string parameter

Secure protocol configuration

Configure a secure protocol to connect to the external application.

Field Description
Lowest allowable SSL/TLS version Select the version of SSL or TLS protocol that you want to use to securely connect to the external application by using OAuth 2.0.

Security settings

Configure the truststore and keystore settings to secure your connection with the external application.

Field Description
Truststore Select or create a Truststore record that contains the server certificate to use in the TLS/SSL handshake.
Keystore Select or create a Keystore record that stores the Pega Platform client's private/public key pair that is used by the server to authenticate the client.