---
title: IdmService
description: Service for making REST API calls to IDM.
component: pinggateway
version: 2025.9
page_id: pinggateway:reference:IdmService
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/IdmService.html
llms_txt: https://docs.pingidentity.com/pinggateway/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pinggateway/2026/reference/IdmService.html
section_ids:
  usage: Usage
  properties: Properties
  more_information: More information
---

# IdmService

Service for making REST API calls to IDM.

## Usage

```none
{
  "name": string,
  "type": "IdmService",
  "config": {
    "baseEndpoint": config expression<uri>,
    "endpointHandler": Handler reference
  }
}
```

## Properties

* `"baseEndpoint"`: *configuration expression<[uri](preface.html#definition-url)>, required*

  The base URI of the IDM instance to use.

* `"endpointHandler"`: *Handler [reference](preface.html#definition-reference), required*

  The [handler](Handlers.html) to make requests to the managed objects endpoint.

  Make sure this handler is configured to get the required IDM authorization, such as an `access_token`.

## More information

[org.forgerock.openig.fapi.apiclient.service.idm.IdmService](../_attachments/apidocs/org/forgerock/openig/fapi/apiclient/service/idm/IdmService.html)
