---
title: PolicyAgents
description: Agents handler that is responsible for managing agents
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-policyagents
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-policyagents.html
section_ids:
  sec-amster-entity-policyagents-realm-ops: Realm Operations
  sec-amster-entity-policyagents-realm-ops-create: create
  sec-amster-entity-policyagents-realm-ops-delete: delete
  sec-amster-entity-policyagents-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-policyagents-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-policyagents-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-policyagents-realm-ops-query: query
  sec-amster-entity-policyagents-realm-ops-read: read
  sec-amster-entity-policyagents-realm-ops-update: update
---

# PolicyAgents

## Realm Operations

Agents handler that is responsible for managing agents

Resource path:

```
/realm-config/agents/2.2_Agent
```

Resource version: `0.0`

### create

**Usage**

```
am> create PolicyAgents --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "description" : {
        "title" : "Description",
        "description" : "",
        "propertyOrder" : 22400,
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "string",
            "required" : true
          }
        }
      },
      "cdssoRootUrl" : {
        "title" : "Agent Key Value(s)",
        "description" : "Set the agent properties with a key/value pair. This property is used by AM to receive agent requests for credential assertions about users. Currently, only one property is valid and all other properties will be ignored. Use the following format: <br> agentRootURL=protocol://hostname:port/ <br> The entry must be precise and agentRootURL is case sensitive.",
        "propertyOrder" : 22500,
        "items" : {
          "type" : "string"
        },
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "array",
            "required" : true
          }
        }
      },
      "userpassword" : {
        "title" : "Password",
        "description" : "",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "status" : {
        "title" : "Status",
        "description" : "Status of the agent configuration.",
        "propertyOrder" : 200,
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "string",
            "required" : true
          }
        }
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete PolicyAgents --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

Querying the agents of a specific type

**Usage**

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

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read PolicyAgents --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update PolicyAgents --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "description" : {
        "title" : "Description",
        "description" : "",
        "propertyOrder" : 22400,
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "string",
            "required" : true
          }
        }
      },
      "cdssoRootUrl" : {
        "title" : "Agent Key Value(s)",
        "description" : "Set the agent properties with a key/value pair. This property is used by AM to receive agent requests for credential assertions about users. Currently, only one property is valid and all other properties will be ignored. Use the following format: <br> agentRootURL=protocol://hostname:port/ <br> The entry must be precise and agentRootURL is case sensitive.",
        "propertyOrder" : 22500,
        "items" : {
          "type" : "string"
        },
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "array",
            "required" : true
          }
        }
      },
      "userpassword" : {
        "title" : "Password",
        "description" : "",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "status" : {
        "title" : "Status",
        "description" : "Status of the agent configuration.",
        "propertyOrder" : 200,
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "string",
            "required" : true
          }
        }
      }
    }
  }
  ```