---
title: Agents
description: Aggregating Agents handler that is responsible for querying the aggregating agents
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-agents
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-agents.html
section_ids:
  sec-amster-entity-agents-realm-ops: Realm Operations
  sec-amster-entity-agents-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-agents-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-agents-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-agents-realm-ops-query: query
  sec-amster-entity-agents-global-ops: Global Operations
  sec-amster-entity-agents-global-ops-getalltypes: getAllTypes
  sec-amster-entity-agents-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-agents-global-ops-nextdescendents: nextdescendents
---

# Agents

## Realm Operations

Aggregating Agents handler that is responsible for querying the aggregating agents

Resource path:

```
/realm-config/agents
```

Resource version: `0.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action Agents --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action Agents --realm Realm --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action Agents --realm Realm --actionName nextdescendents
```

### query

Querying the aggregating agents

**Usage**

```
am> query Agents --realm Realm --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all. Fields that can be queried: \[\*]

## Global Operations

Global and default configuration for agents

Resource path:

```
/global-config/agents
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action Agents --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action Agents --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action Agents --global --actionName nextdescendents
```