---
title: DeviceProfileCollector
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-deviceprofilecollector
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-deviceprofilecollector.html
section_ids:
  sec-amster-entity-deviceprofilecollector-realm-ops: Realm Operations
  sec-amster-entity-deviceprofilecollector-realm-ops-create: create
  sec-amster-entity-deviceprofilecollector-realm-ops-delete: delete
  sec-amster-entity-deviceprofilecollector-realm-ops-gettype: getType
  sec-amster-entity-deviceprofilecollector-realm-ops-getupgradedconfig: getUpgradedConfig
  sec-amster-entity-deviceprofilecollector-realm-ops-query: query
  sec-amster-entity-deviceprofilecollector-realm-ops-read: read
  sec-amster-entity-deviceprofilecollector-realm-ops-update: update
  sec-amster-entity-deviceprofilecollector-realm-ops-versioninfo: versionInfo
---

# DeviceProfileCollector

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/DeviceProfileCollectorNode/1.0
```

Resource version: `3.0`

### create

**Usage**

```
am> create DeviceProfileCollector --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" : {
      "deviceMetadata" : {
        "title" : "Collect Device Metadata",
        "description" : "Instructs the client to collect device metadata.",
        "propertyOrder" : 200,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "message" : {
        "title" : "Message",
        "description" : "Optional message to display to the user when capturing device information. Enter a locale in the KEY field, for example `en-us`, and the localized message as the VALUE.",
        "propertyOrder" : 400,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "deviceLocation" : {
        "title" : "Collect Device Location",
        "description" : "Instructs the client to collect device location.",
        "propertyOrder" : 300,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "maximumSize" : {
        "title" : "Maximum Profile Size (KB)",
        "description" : "Specify the maximum accepted size for a device profile in kilobytes. If the returned profile size exceeds this maximum the authentication will fail. Note that larger profiles can impact performance.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "deviceMetadata", "message", "deviceLocation", "maximumSize" ]
  }
  ```

### delete

**Usage**

```
am> delete DeviceProfileCollector --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getType

List information related to the node such as a name, description, tags and metadata.

**Usage**

```
am> action DeviceProfileCollector --realm Realm --actionName getType
```

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

```
am> action DeviceProfileCollector --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "title" : "The current configuration of the node type."
  }
  ```

* *\--targetVersion*

  \=== listOutcomes

List the available outcomes for the node type.

**Usage**

```
am> action DeviceProfileCollector --realm Realm --body body --actionName listOutcomes
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.",
    "type" : "object",
    "title" : "Node configuration"
  }
  ```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update DeviceProfileCollector --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" : {
      "deviceMetadata" : {
        "title" : "Collect Device Metadata",
        "description" : "Instructs the client to collect device metadata.",
        "propertyOrder" : 200,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "message" : {
        "title" : "Message",
        "description" : "Optional message to display to the user when capturing device information. Enter a locale in the KEY field, for example `en-us`, and the localized message as the VALUE.",
        "propertyOrder" : 400,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "deviceLocation" : {
        "title" : "Collect Device Location",
        "description" : "Instructs the client to collect device location.",
        "propertyOrder" : 300,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "maximumSize" : {
        "title" : "Maximum Profile Size (KB)",
        "description" : "Specify the maximum accepted size for a device profile in kilobytes. If the returned profile size exceeds this maximum the authentication will fail. Note that larger profiles can impact performance.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "deviceMetadata", "message", "deviceLocation", "maximumSize" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

```
am> action DeviceProfileCollector --realm Realm --actionName versionInfo
```