PingAuthorize

Customizing the shared secret header

By default, the Sideband API accepts a shared secret from an API gateway plugin through the CLIENT-TOKEN header.

Steps

  • To customize a shared secret header, change the value of the Sideband API HTTP Servlet Extension’s shared-secret-header property.

    Example:

    The following command changes the shared secret header to x-shared-secret:

    {pingauthorize}/bin/dsconfig set-http-servlet-extension-prop \
      --extension-name "Sideband API" \
      --set shared-secret-header-name:x-shared-secret

    The following command resets the shared secret header to its default value:

    {pingauthorize}/bin/dsconfig set-http-servlet-extension-prop \
      --extension-name "Sideband API" \
      --reset shared-secret-header-name