---
title: IdentityGatewayAgents
description: Agents handler that is responsible for managing agents
component: pingam
version: 7.2
page_id: pingam:entity-reference:sec-amster-entity-identitygatewayagents
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-identitygatewayagents.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-identitygatewayagents.html
section_ids:
sec-amster-entity-identitygatewayagents-realm-ops: Realm Operations
sec-amster-entity-identitygatewayagents-realm-ops-create: create
sec-amster-entity-identitygatewayagents-realm-ops-delete: delete
sec-amster-entity-identitygatewayagents-realm-ops-getalltypes: getAllTypes
sec-amster-entity-identitygatewayagents-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-identitygatewayagents-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-identitygatewayagents-realm-ops-query: query
sec-amster-entity-identitygatewayagents-realm-ops-read: read
sec-amster-entity-identitygatewayagents-realm-ops-update: update
---
# IdentityGatewayAgents
## Realm Operations
Agents handler that is responsible for managing agents
Resource path:
```
/realm-config/agents/IdentityGatewayAgent
```
Resource version: `1.0`
### create
**Usage**
```
am> create IdentityGatewayAgents --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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : true
}
}
},
"userpassword" : {
"title" : "Password",
"description" : "",
"propertyOrder" : 100,
"required" : true,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"igCdssoRedirectUrls" : {
"title" : "Redirect URLs for CDSSO",
"description" : "The list of redirect URLs for CDSSO. The valid value is in the following format:
protocol://hostname:port/path
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.
Example:
http://openig.ext.com:8080/home/cdsso/redirect",
"propertyOrder" : 150,
"items" : {
"type" : "string"
},
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "array",
"required" : false
}
}
},
"agentgroup" : {
"title" : "Group",
"description" : "Add the agent to a group to allow inheritance of property values from the group.
Changing the group will update inherited property values.
Inherited property values are copied to the agent.",
"propertyOrder" : 50,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"igTokenIntrospection" : {
"title" : "Token Introspection",
"description" : "Allows using this IG agent to introspect OAuth 2.0 tokens issued to any client.
Select None to disable. Select Realm Only to allow introspection of tokens in the same realm. Select Realm and Sub Realms to allow introspection of tokens in the same realm and any sub-realms.",
"propertyOrder" : 160,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
}
}
}
```
### delete
**Usage**
```
am> delete IdentityGatewayAgents --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 IdentityGatewayAgents --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action IdentityGatewayAgents --realm Realm --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action IdentityGatewayAgents --realm Realm --actionName nextdescendents
```
### query
Querying the agents of a specific type
**Usage**
```
am> query IdentityGatewayAgents --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read IdentityGatewayAgents --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update IdentityGatewayAgents --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,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : true
}
}
},
"userpassword" : {
"title" : "Password",
"description" : "",
"propertyOrder" : 100,
"required" : true,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"igCdssoRedirectUrls" : {
"title" : "Redirect URLs for CDSSO",
"description" : "The list of redirect URLs for CDSSO. The valid value is in the following format:
protocol://hostname:port/path
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.
Example:
http://openig.ext.com:8080/home/cdsso/redirect",
"propertyOrder" : 150,
"items" : {
"type" : "string"
},
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "array",
"required" : false
}
}
},
"agentgroup" : {
"title" : "Group",
"description" : "Add the agent to a group to allow inheritance of property values from the group.
Changing the group will update inherited property values.
Inherited property values are copied to the agent.",
"propertyOrder" : 50,
"required" : false,
"type" : "string",
"exampleValue" : ""
},
"igTokenIntrospection" : {
"title" : "Token Introspection",
"description" : "Allows using this IG agent to introspect OAuth 2.0 tokens issued to any client.
Select None to disable. Select Realm Only to allow introspection of tokens in the same realm. Select Realm and Sub Realms to allow introspection of tokens in the same realm and any sub-realms.",
"propertyOrder" : 160,
"type" : "object",
"exampleValue" : "",
"properties" : {
"inherited" : {
"type" : "boolean",
"required" : true
},
"value" : {
"type" : "string",
"required" : false
}
}
}
}
}
```