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

# PingOneIdentityMatch

## Realm Operations

Resource path:

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

Resource version: `3.0`

### create

**Usage**

```
am> create PingOneIdentityMatch --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" : {
      "amIdentityAttribute" : {
        "title" : "AM identity attribute",
        "description" : "The attribute of the existing AM identity object that will be used to query the PingOne user. If there are multiple entries with the same attribute value in the PingOne directory server, ensure that this property is specific enough to retrieve only one entry.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      },
      "captureFailure" : {
        "title" : "Capture failure",
        "description" : "If selected, a failure is captured in shared state under a keynamed <code>pingOneIdentityMatchFailureReason</code> for use by subsequent nodes in the journey.",
        "propertyOrder" : 400,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "pingIdentityAttribute" : {
        "title" : "PingOne identity attribute",
        "description" : "The PingOne user attribute to be used for matching the AM user. If this attribute identifies more than one user with the same value in the PingOne system, it will fail.",
        "propertyOrder" : 300,
        "type" : "string",
        "exampleValue" : ""
      },
      "pingOneWorker" : {
        "title" : "PingOne Worker service ID",
        "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "amIdentityAttribute", "captureFailure", "pingIdentityAttribute", "pingOneWorker" ]
  }
  ```

### delete

**Usage**

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

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update PingOneIdentityMatch --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" : {
      "amIdentityAttribute" : {
        "title" : "AM identity attribute",
        "description" : "The attribute of the existing AM identity object that will be used to query the PingOne user. If there are multiple entries with the same attribute value in the PingOne directory server, ensure that this property is specific enough to retrieve only one entry.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      },
      "captureFailure" : {
        "title" : "Capture failure",
        "description" : "If selected, a failure is captured in shared state under a keynamed <code>pingOneIdentityMatchFailureReason</code> for use by subsequent nodes in the journey.",
        "propertyOrder" : 400,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "pingIdentityAttribute" : {
        "title" : "PingOne identity attribute",
        "description" : "The PingOne user attribute to be used for matching the AM user. If this attribute identifies more than one user with the same value in the PingOne system, it will fail.",
        "propertyOrder" : 300,
        "type" : "string",
        "exampleValue" : ""
      },
      "pingOneWorker" : {
        "title" : "PingOne Worker service ID",
        "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "amIdentityAttribute", "captureFailure", "pingIdentityAttribute", "pingOneWorker" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

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