Sideband API configuration basics - PingAuthorize - 9.2

The sideband API consists of the following components.

Sideband API Shared Secrets

Defines the authentication credentialscredential Information used to identify a subject for access purposes (for example, username and password). A credential can also be a certificate. that the sideband API might require an API gateway adapteradapter Plug-in software that allows Ping products to interact with web applications and authentication systems. to present. For more information, see Authenticating to the Sideband API.

Sideband API HTTP Servlet Extension

Represents the sideband API itself. If you require shared secrets, you might need to configure this component. For more information, see Authenticating to the Sideband API.

Sideband API Endpoints

Represents a public path prefix that the sideband API accepts for handling proxied requests. A sideband API endpointendpoint One end in a communication channel, typically a URI. configuration defines the following items:

• The base path (base-path) for requests that the sideband API accepts
• Properties that relate to policy processing, such as service, which targets the policy requests that are generated for the sideband API endpoint to specific policies

PingAuthorize Server's default configuration includes a default sideband API endpoint that accepts all API requests and generates policy requests for the service Default. To customize policy requests further, an administrator can create additional sideband API endpoints. For more information about using the sideband API endpoint configuration to customize policy requests, see Sideband API policy requests.

PingAuthorize/bin/dsconfig create-sideband-api-endpoint \
  --endpoint-name "Consent Definitions" \
  --set base-path:/c/definitions \
  --set service:Consent

PingAuthorize/bin/dsconfig create-sideband-api-endpoint \
  --endpoint-name "Consent Records" \
  --set base-path:/c/consents \
  --set service:Consent