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

# DeviceSigningVerifier

## Realm Operations

Resource path:

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

Resource version: `3.0`

### create

**Usage**

```
am> create DeviceSigningVerifier --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" : {
      "challenge" : {
        "title" : "Sign Random Challenge.",
        "description" : "Auto generate challenge for signing.",
        "propertyOrder" : 100,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "sharedStateAttribute" : {
        "title" : "Shared State Attribute As Challenge.",
        "description" : "Shared State attribute as challenge for signing.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      },
      "subtitle" : {
        "title" : "Subtitle",
        "description" : "The subtitle to be displayed on the biometric prompt.",
        "propertyOrder" : 400,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "description" : {
        "title" : "Description",
        "description" : "The description to be displayed on the biometric prompt.",
        "propertyOrder" : 500,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "captureFailure" : {
        "title" : "Capture Failure",
        "description" : "If enabled, instead of stopping the journey's execution for error scenario, it will route to the <code>Failure</code> outcome, failure reason is captured in shared state, accessible to subsequent nodes in the journey with variable <code>DeviceSigningVerifierNode.FAILURE</code>: <ul><li><code>INVALID_CLAIM</code> - Failed to validate the token claim attribute.</li><li><code>INVALID_SIGNATURE</code> - Failed to validate the token signature.</li><li><code>INVALID_USER</code> - Account does not exist.</li><li><code>NOT_ACTIVE_USER</code> - Account is not active or locked out.</li><li><code>INVALID_SUBJECT</code> - Failed to validate the token subject.</li></ul>",
        "propertyOrder" : 650,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "timeout" : {
        "title" : "Timeout",
        "description" : "The number of seconds to wait for a valid device to be bound before failing.",
        "propertyOrder" : 600,
        "type" : "integer",
        "exampleValue" : ""
      },
      "skewAllowance" : {
        "title" : "Skew Allowance",
        "description" : "Defines the maximum allowed clock difference in seconds between the end-user device and PingAM.",
        "propertyOrder" : 800,
        "type" : "integer",
        "exampleValue" : ""
      },
      "clientErrorOutcomes" : {
        "title" : "Client Error Outcomes",
        "description" : "Specify the client error outcomes",
        "propertyOrder" : 700,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "applicationIds" : {
        "title" : "Application Ids",
        "description" : "The Android package names or iOS bundle IDs that issue the binding request.",
        "propertyOrder" : 250,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      },
      "title" : {
        "title" : "Title",
        "description" : "The title to be displayed on the biometric prompt.",
        "propertyOrder" : 300,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      }
    },
    "required" : [ "challenge", "sharedStateAttribute", "subtitle", "description", "captureFailure", "timeout", "skewAllowance", "clientErrorOutcomes", "applicationIds", "title" ]
  }
  ```

### delete

**Usage**

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

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update DeviceSigningVerifier --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" : {
      "challenge" : {
        "title" : "Sign Random Challenge.",
        "description" : "Auto generate challenge for signing.",
        "propertyOrder" : 100,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "sharedStateAttribute" : {
        "title" : "Shared State Attribute As Challenge.",
        "description" : "Shared State attribute as challenge for signing.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      },
      "subtitle" : {
        "title" : "Subtitle",
        "description" : "The subtitle to be displayed on the biometric prompt.",
        "propertyOrder" : 400,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "description" : {
        "title" : "Description",
        "description" : "The description to be displayed on the biometric prompt.",
        "propertyOrder" : 500,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "captureFailure" : {
        "title" : "Capture Failure",
        "description" : "If enabled, instead of stopping the journey's execution for error scenario, it will route to the <code>Failure</code> outcome, failure reason is captured in shared state, accessible to subsequent nodes in the journey with variable <code>DeviceSigningVerifierNode.FAILURE</code>: <ul><li><code>INVALID_CLAIM</code> - Failed to validate the token claim attribute.</li><li><code>INVALID_SIGNATURE</code> - Failed to validate the token signature.</li><li><code>INVALID_USER</code> - Account does not exist.</li><li><code>NOT_ACTIVE_USER</code> - Account is not active or locked out.</li><li><code>INVALID_SUBJECT</code> - Failed to validate the token subject.</li></ul>",
        "propertyOrder" : 650,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "timeout" : {
        "title" : "Timeout",
        "description" : "The number of seconds to wait for a valid device to be bound before failing.",
        "propertyOrder" : 600,
        "type" : "integer",
        "exampleValue" : ""
      },
      "skewAllowance" : {
        "title" : "Skew Allowance",
        "description" : "Defines the maximum allowed clock difference in seconds between the end-user device and PingAM.",
        "propertyOrder" : 800,
        "type" : "integer",
        "exampleValue" : ""
      },
      "clientErrorOutcomes" : {
        "title" : "Client Error Outcomes",
        "description" : "Specify the client error outcomes",
        "propertyOrder" : 700,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "applicationIds" : {
        "title" : "Application Ids",
        "description" : "The Android package names or iOS bundle IDs that issue the binding request.",
        "propertyOrder" : 250,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      },
      "title" : {
        "title" : "Title",
        "description" : "The title to be displayed on the biometric prompt.",
        "propertyOrder" : 300,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      }
    },
    "required" : [ "challenge", "sharedStateAttribute", "subtitle", "description", "captureFailure", "timeout", "skewAllowance", "clientErrorOutcomes", "applicationIds", "title" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

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