---
title: IdentityGatewayAgentGroups
description: Agent Groups handler that is responsible for managing agent groups
component: pingam
version: 7.2
page_id: pingam:entity-reference:sec-amster-entity-identitygatewayagentgroups
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-identitygatewayagentgroups.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-identitygatewayagentgroups.html
section_ids:
  sec-amster-entity-identitygatewayagentgroups-realm-ops: Realm Operations
  sec-amster-entity-identitygatewayagentgroups-realm-ops-create: create
  sec-amster-entity-identitygatewayagentgroups-realm-ops-delete: delete
  sec-amster-entity-identitygatewayagentgroups-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-identitygatewayagentgroups-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-identitygatewayagentgroups-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-identitygatewayagentgroups-realm-ops-query: query
  sec-amster-entity-identitygatewayagentgroups-realm-ops-read: read
  sec-amster-entity-identitygatewayagentgroups-realm-ops-update: update
---

# IdentityGatewayAgentGroups

## Realm Operations

Agent Groups handler that is responsible for managing agent groups

Resource path:

```
/realm-config/agents/groups/IdentityGatewayAgent
```

Resource version: `1.0`

### create

**Usage**

```
am> create IdentityGatewayAgentGroups --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" : {
      "status" : {
        "title" : "Status",
        "description" : "Status of the agent configuration.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "igTokenIntrospection" : {
        "title" : "Token Introspection",
        "description" : "Allows using this IG agent to introspect OAuth 2.0 tokens issued to any client. <br>Select <code>None</code> to disable. Select <code>Realm Only</code> to allow introspection of tokens in the same realm. Select <code>Realm and Sub Realms</code> to allow introspection of tokens in the same realm and any sub-realms.",
        "propertyOrder" : 160,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "igCdssoRedirectUrls" : {
        "title" : "Redirect URLs for CDSSO",
        "description" : "The list of redirect URLs for CDSSO. The valid value is in the following format: <br>protocol://hostname:port/path<br> The protocol represents the protocol used, such as http or https. The hostname represents the host name of the machine on which IG resides. The port represents the port number on which IG is listening. The path represents the remainder of the redirect URL. <br>Example:<br> http://openig.ext.com:8080/home/cdsso/redirect",
        "propertyOrder" : 150,
        "required" : false,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

Querying the agent groups of a specific type

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update IdentityGatewayAgentGroups --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" : {
      "status" : {
        "title" : "Status",
        "description" : "Status of the agent configuration.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "igTokenIntrospection" : {
        "title" : "Token Introspection",
        "description" : "Allows using this IG agent to introspect OAuth 2.0 tokens issued to any client. <br>Select <code>None</code> to disable. Select <code>Realm Only</code> to allow introspection of tokens in the same realm. Select <code>Realm and Sub Realms</code> to allow introspection of tokens in the same realm and any sub-realms.",
        "propertyOrder" : 160,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "igCdssoRedirectUrls" : {
        "title" : "Redirect URLs for CDSSO",
        "description" : "The list of redirect URLs for CDSSO. The valid value is in the following format: <br>protocol://hostname:port/path<br> The protocol represents the protocol used, such as http or https. The hostname represents the host name of the machine on which IG resides. The port represents the port number on which IG is listening. The path represents the remainder of the redirect URL. <br>Example:<br> http://openig.ext.com:8080/home/cdsso/redirect",
        "propertyOrder" : 150,
        "required" : false,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```
