---
title: PingOneService
description: Holds information about a PingOne environment. Filters using the environment reference a PingOneService.
component: pinggateway
version: 2026
page_id: pinggateway:reference:PingOneService
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/PingOneService.html
revdate: 2025-07-07T16:48:22Z
section_ids:
  usage: Usage
  properties: Properties
  example: Example
---

# PingOneService

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

## Usage

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

## Properties

* `"serviceEndpoint"`: *configuration expression<[url](preface.html#definition-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](preface.html#definition-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](ForgeRockClientHandler.html) as defined in the heap

## Example

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

```json
{
    "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.