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

# SharedAgents

## Realm Operations

Agents handler that is responsible for managing agents

Resource path:

```
/realm-config/agents/SharedAgent
```

Resource version: `0.0`

### create

**Usage**

```
am> create SharedAgents --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" : {
      "agentProfilesAllowedToRead" : {
        "title" : "Agent Profiles allowed to Read.",
        "description" : "",
        "propertyOrder" : 22600,
        "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" : ""
      },
      "cdssoRootUrl" : {
        "title" : "Agent Root URL for CDSSO",
        "description" : "The list of agent root URLs for CDSSO. The valid value is in the format protocol://hostname:port/, where protocol represents the protocol used, such as http or https, hostname represents the host name of the system where the agent resides, and port represents the port number on which the agent is installed. The slash following the port number is required.<br> If your agent system also has virtual host names, add URLs with the virtual host names to this list as well. AM checks that goto URLs match one of the agent root URLs for CDSSO.<br>Property: sunIdentityServerDeviceKeyValue <br>Valid for Agent 5.0 onwards",
        "propertyOrder" : 22700,
        "items" : {
          "type" : "string"
        },
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "array",
            "required" : true
          }
        }
      },
      "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 SharedAgents --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 SharedAgents --realm Realm --actionName getAllTypes
```

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

Querying the agents of a specific type

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update SharedAgents --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" : {
      "agentProfilesAllowedToRead" : {
        "title" : "Agent Profiles allowed to Read.",
        "description" : "",
        "propertyOrder" : 22600,
        "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" : ""
      },
      "cdssoRootUrl" : {
        "title" : "Agent Root URL for CDSSO",
        "description" : "The list of agent root URLs for CDSSO. The valid value is in the format protocol://hostname:port/, where protocol represents the protocol used, such as http or https, hostname represents the host name of the system where the agent resides, and port represents the port number on which the agent is installed. The slash following the port number is required.<br> If your agent system also has virtual host names, add URLs with the virtual host names to this list as well. AM checks that goto URLs match one of the agent root URLs for CDSSO.<br>Property: sunIdentityServerDeviceKeyValue <br>Valid for Agent 5.0 onwards",
        "propertyOrder" : 22700,
        "items" : {
          "type" : "string"
        },
        "type" : "object",
        "exampleValue" : "",
        "properties" : {
          "inherited" : {
            "type" : "boolean",
            "required" : true
          },
          "value" : {
            "type" : "array",
            "required" : true
          }
        }
      },
      "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
          }
        }
      }
    }
  }
  ```