How to use the User Defined (OAuth) credential type


Note: This article applies to the web services data actions integration.

When you add the web services data actions integration, you can select a credential type: Basic Auth, User Defined, or User Defined (OAuth). For more information, see Add a data actions integration and Credential types.

This article explains how to use the User Defined (OAuth) credential type. For more information, see Workflow for User Defined (OAuth) credential type.

  1. When you add the integration, configure the User Defined (OAuth) credentials.

    Add field names used by your web service and values for these field names.

    Configure Credentials for User Defined (OAuth)

    The integration creates a custom auth action that returns an authentication response.

  2. Configure the custom auth action with the information needed to authenticate with the defined endpoint.

    The integration then makes these field names and values available for use in subsequent custom actions. The authentication response values are accessible in the authResponse Velocity context.

    To configure your auth action, follow these steps:

    1. Open the custom auth action.

      You can access the custom auth action two ways:

      • From the Credentials page for the action, click Custom Auth Action.
      • From the Actions page, click the custom auth action for your integration. For more information, see Manage actions.
    2. Click the Setup tab.
    3. Click the Configuration tab.

      The Request for the custom auth action includes authorization information. In the following example, the authorization is included in the headers. credentials is a static keyword. loginUrl, clientId, and clientSecret are the field names added to the credential configuration.

      Warning: Be sure to escape any use of input or output variables within requestTemplate, successTemplate, or requestUrlTemplate. If you do not properly escape variables with special characters, your data actions will fail at execution.
      • Use esc.jsonString to escape strings inside JSON bodies.

        For more information, see the esc.jsonString section in Velocity macros for data actions.

      • Use esc.url() or urlTool.optionalQueryParam() to properly escape path or query parameters for a requestUrlTemplate or requestTemplate if using x-www.form-urlencoded values.

        For more information, see the String-escaping library section in Velocity macros for data actions.

      Because escaping is JSON context-specific, the following example intentionally does not show escaping.

      {
        "requestUrlTemplate": "${credentials.loginUrl}",
        "requestType": "POST",
        "headers": {
          "Authorization": "Basic $encoding.base64(\"${credentials.clientId}:${credentials.clientSecret}\")",
          "Content-Type": "application/x-www-form-urlencoded"
        },
        "requestTemplate": "grant_type=client_credentials"
      }
      
    4. Click the Test tab.
    5. Click Run Action.

      The integration executes the custom auth action and outputs what your web service returns (with values redacted). In the following example, the web service returns access_token for clientId, token_type for clientSecret, and expires_in

      {
        "access_token": "<redacted string(86)>",
        "token_type": "<redacted string(6)>",
        "expires_in": "<redacted number>"
      }
  3. Use the auth response that your web service returns in the requests of all custom actions that you create. 

    The following example is a request for a custom action called Get Presence. The header of the custom action request includes the authorization. authResponse is a static keyword. token_type and access_token are the values returned from the web service. For more information, see Create a custom action, Add configuration to custom actions, and Request configuration.

    {
      "requestUrlTemplate": "https://api.mypurecloud.com/api/v2/users/${input.USER_ID}/presences/PURECLOUD",
      "requestType": "GET",
      "headers": {
        "Authorization": "${authResponse.token_type} ${authResponse.access_token}",
      },
      "requestTemplate": "${input.rawRequest}"
    }
    Note: When you test a custom action, the integration redacts any authorization information. For more information, see Test a custom action.

For more information about the integration, see About the web services data actions integration.