PingGateway 2024.9

PingOneService

Holds information about a PingOne environment. Filters using the environment reference a PingOneService.

Usage

{
  "name": string,
  "type": "PingOneService",
  "config": {
    "serviceEndpoint": configuration expression<url>,
    "endpointHandler": Handler reference
  }
}

Properties

"serviceEndpoint": configuration expression<url>, required

The PingOne root service endpoint for the environment from which PingGateway derives other service endpoints.

Example: https://api.pingone.eu/v1/environments/&{envId}.

"endpointHandler": Handler reference, optional

The handler to make requests to the service endpoints.

Make sure this handler can obtain the PingOne access tokens for the services it makes requests to.

Default: ForgeRockClientHandler as defined in the heap

Example

The following example shows a PingOneService using the default endpoint handler to access the environment:

{
    "name": "PingOneService-1",
    "type": "PingOneService",
    "config": {
        "serviceEndpoint": "https://api.pingone.eu/v1/environments/eeff3566-2e5a-4d35-a48d-19090fcefb5e"
    }
}

In your environment, get the ID from Settings > Environment Properties > Environment ID.