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

# SoapStsAgents

## Realm Operations

Agents handler that is responsible for managing agents

Resource path:

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

Resource version: `2.0`

### create

**Usage**

```
am> create SoapStsAgents --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" : {
      "agentgroup" : {
        "title" : "Group",
        "description" : "Add the agent to a group to allow inheritance of property values from the group. <br>Changing the group will update inherited property values. <br>Inherited property values are copied to the agent.",
        "propertyOrder" : 50,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "userpassword" : {
        "title" : "Password",
        "description" : "",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "publishServicePollInterval" : {
        "title" : "Poll Interval",
        "description" : "Interval, in seconds, to poll the sts publish service for newly-published SOAP STS instances.",
        "propertyOrder" : 26300,
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "integer",
            "required" : true
          }
        }
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete SoapStsAgents --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 SoapStsAgents --realm Realm --actionName getAllTypes
```

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

Querying the agents of a specific type

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update SoapStsAgents --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" : {
      "agentgroup" : {
        "title" : "Group",
        "description" : "Add the agent to a group to allow inheritance of property values from the group. <br>Changing the group will update inherited property values. <br>Inherited property values are copied to the agent.",
        "propertyOrder" : 50,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "userpassword" : {
        "title" : "Password",
        "description" : "",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "publishServicePollInterval" : {
        "title" : "Poll Interval",
        "description" : "Interval, in seconds, to poll the sts publish service for newly-published SOAP STS instances.",
        "propertyOrder" : 26300,
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "integer",
            "required" : true
          }
        }
      }
    }
  }
  ```