---
title: Heap objects
description: A heaplet creates and initializes an object that is stored in a heap. A heaplet can retrieve objects it depends on from the heap.
component: pinggateway
version: 2023.11
page_id: pinggateway:reference:heap-objects
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/heap-objects.html
llms_txt: https://docs.pingidentity.com/pinggateway/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: 2025-06-03T11:21:31Z
superseded_by: https://docs.pingidentity.com/pinggateway/2026/reference/heap-objects.html
section_ids:
  heap-objects-usage: Usage
  heap-objects-properties: Properties
  heap-objects-moreinfo: More information
---

# Heap objects

A *heaplet* creates and initializes an object that is stored in a heap. A heaplet can retrieve objects it depends on from the heap.

A *heap* is a collection of associated objects created and initialized by heaplet objects. All configurable objects in IG are heap objects.

The heap configuration is included as an object in `admin.json` and `config.json`.

## Usage

```json
[
    {
        "name": string,
        "type": string,
        "config": {
            object-specific configuration
        }
    },
    ...
]
```

## Properties

* `"name"`: *[string](preface.html#definition-string), required except for inline objects*

  The unique name to give the heap object in the heap. This name is used to resolve the heap object, for example, when another heap object names a heap object dependency.

* `"type"`: *[string](preface.html#definition-string), required*

  The class name of the object to be created. To determine the type name, see the object's documentation in this reference.

* `"config"`: *[object](preface.html#definition-object), required*

  The configuration that is specific to the heap object being created.

  If all the fields are optional and the configuration uses only default settings, you can omit the config field instead of including an empty config object as the field value.

## More information

[org.forgerock.openig.heap.Heap](../_attachments/apidocs/org/forgerock/openig/heap/Heap.html)