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

# SoapSTSAgentGroups

## Realm Operations

Agent Groups handler that is responsible for managing agent groups

Resource path:

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

Resource version: `2.0`

### create

**Usage**

```
am> create SoapSTSAgentGroups --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" : {
      "publishServicePollInterval" : {
        "title" : "Poll Interval",
        "description" : "Interval, in seconds, to poll the sts publish service for newly-published SOAP STS instances.",
        "propertyOrder" : 26300,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

Querying the agent groups of a specific type

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update SoapSTSAgentGroups --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" : {
      "publishServicePollInterval" : {
        "title" : "Poll Interval",
        "description" : "Interval, in seconds, to poll the sts publish service for newly-published SOAP STS instances.",
        "propertyOrder" : 26300,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      }
    }
  }
  ```