Creating a shared secret
Define the authentication credentials that the Sideband API might require an API gateway plugin to present.
Steps
-
To create a shared secret, run the following example
dsconfig
command, substituting values of your choosing.Example:
{pingauthorize}/bin/dsconfig create-sideband-api-shared-secret \ --secret-name "Shared Secret A" \ --set "shared-secret:secret123"
-
The
shared-secret
property sets the value that the Sideband API requires the API gateway plugin to present. After you set this value, it is no longer visible. -
The
secret-name
property is a label that allows an administrator to distinguish one Sideband API Shared Secret from another.
-
-
To update the
shared-secrets
property, run the following exampledsconfig
command.Example:
{pingauthorize}/bin/dsconfig set-http-servlet-extension-prop \ --extension-name "Sideband API" \ --add "shared-secrets:Shared Secret A"
A new Sideband API Shared Secret is not used until the
shared-secrets
property of the Sideband API HTTP Servlet Extension is updated.