OAuth 2.0 Authentication

For all the Grant Types that you can select, the following four fields are common configuration. Other Grant Type details are described in the following sub-sections.

  1. From the Authentication Type drop-down list, select OAuth 2.0.

  2. In the Base URL field, enter the base URL to connect to the target managed system.

    For example:

    https://api.testurl.com

  3. Enter the Token URL. The format is:

    https://{your domain}/token

    The Web Services source supports the replacement of attributes in the OAuth2 token URL. For example, if you want to prepare a token URL with sensitive information such as client_secret, the $application.client_secret$ can be used. So, the corresponding value will be determined from the replaced location in the token URL.

  4. For OAuth Headers, set up the custom headers as part of access token. The Web Services source adheres to the generalized specifications of the OAuth2 grant types. However, for some managed target systems, custom headers may be required to be part of the access token generation request. You can add the custom headers as an attribute.

  5. In OAuth Headers to Exclude, enter the headers that you want to exclude. By default, an Authorization BASIC header with Base64-encoded client ID and client secret are a part of the access token generation request. Some managed target systems do not support this header. If there is no Authorization BASIC header required for such managed target systems, it can be excluded from the request.

  6. For OAuth Request Parameters, set up the custom parameters for an access token. For some managed target systems, custom request parameters may be required to be part of the access token generation request. You can add the custom request parameter as an attribute.

  7. For OAuth Body Attributes to Exclude, enter the attributes that you want to exclude. To remove any of the standard request parameters which are not supported by managed target systems access token generation requests, configure the request parameters to exclude from the access token request.

  8. Select a Grant Type and complete the configuration.

    • Password Grant Type

    • Client Credentials

    • Refresh Token

    • JWT Bearer Token

    • SAML Bearer Assertion