PingAuthorize Server Documentation Index
Configuration Reference Home

Sideband API Shared Secret

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

A shared secret sent by the third-party API Gateway on sideband HTTP requests.

The server will compare this shared secret to the one passed in by the third-party API Gateway to authenticate its HTTP requests.

↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct aggregation relation to Sideband API Shared Secrets:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ shared-secret  None

Basic Properties

shared-secret (Read-Only)

Description
A shared secret sent by the third-party API Gateway on sideband HTTP requests. The server will compare this shared secret value to the one passed in by the third-party API Gateway to authenticate its HTTP requests.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Sideband API Shared Secrets:

dsconfig list-sideband-api-shared-secrets
     [--property {propertyName}] ...

To view the configuration for an existing Sideband API Shared Secret:

dsconfig get-sideband-api-shared-secret-prop
     --secret-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Sideband API Shared Secret:

dsconfig set-sideband-api-shared-secret-prop
     --secret-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Sideband API Shared Secret:

dsconfig create-sideband-api-shared-secret
     --secret-name {name}
     --set shared-secret:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Sideband API Shared Secret:

dsconfig delete-sideband-api-shared-secret
     --secret-name {name}