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

# DeviceMatch

## Realm Operations

Resource path:

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

Resource version: `3.0`

### create

**Usage**

```
am> create DeviceMatch --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" : {
      "useScript" : {
        "title" : "Use Custom Matching Script",
        "description" : "Use a custom script for matching device profiles. When enabled, the Acceptable Variance and Expiration properties are ignored. The script's type has to be: Decision Node Script.",
        "propertyOrder" : 300,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "expiration" : {
        "title" : "Expiration",
        "description" : "Specify the number of days until profile expiration. Expired profiles will not match.",
        "propertyOrder" : 200,
        "type" : "integer",
        "exampleValue" : ""
      },
      "script" : {
        "title" : "Custom Matching Script",
        "description" : "Decision Node Script",
        "propertyOrder" : 400,
        "type" : "string",
        "exampleValue" : ""
      },
      "acceptableVariance" : {
        "title" : "Acceptable Variance",
        "description" : "Specify the maximum amount of device attribute differences that is still acceptable for a match.",
        "propertyOrder" : 100,
        "type" : "integer",
        "exampleValue" : ""
      }
    },
    "required" : [ "useScript", "expiration", "script", "acceptableVariance" ]
  }
  ```

### delete

**Usage**

```
am> delete DeviceMatch --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 DeviceMatch --realm Realm --actionName getType
```

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

```
am> action DeviceMatch --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 DeviceMatch --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 DeviceMatch --realm Realm --filter filter
```

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update DeviceMatch --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" : {
      "useScript" : {
        "title" : "Use Custom Matching Script",
        "description" : "Use a custom script for matching device profiles. When enabled, the Acceptable Variance and Expiration properties are ignored. The script's type has to be: Decision Node Script.",
        "propertyOrder" : 300,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "expiration" : {
        "title" : "Expiration",
        "description" : "Specify the number of days until profile expiration. Expired profiles will not match.",
        "propertyOrder" : 200,
        "type" : "integer",
        "exampleValue" : ""
      },
      "script" : {
        "title" : "Custom Matching Script",
        "description" : "Decision Node Script",
        "propertyOrder" : 400,
        "type" : "string",
        "exampleValue" : ""
      },
      "acceptableVariance" : {
        "title" : "Acceptable Variance",
        "description" : "Specify the maximum amount of device attribute differences that is still acceptable for a match.",
        "propertyOrder" : 100,
        "type" : "integer",
        "exampleValue" : ""
      }
    },
    "required" : [ "useScript", "expiration", "script", "acceptableVariance" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

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