---
title: JSON Equality Matching Rule
description: JSON Equality Matching Rules determine whether two JSON values are equivalent using a custom set of rules.
component: pingds
version: 8.1
page_id: pingds:configref:objects-json-equality-matching-rule
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-json-equality-matching-rule.html
section_ids:
  parent: Parent
  json_equality_matching_rule_properties: JSON Equality Matching Rule properties
  basic_properties: Basic properties
  case-sensitive-strings: case-sensitive-strings
  enabled: enabled
  ignore-white-space: ignore-white-space
  json-keys: json-keys
  matching-rule-name: matching-rule-name
  matching-rule-oid: matching-rule-oid
  advanced_properties: Advanced properties
  java-class: java-class
---

# JSON Equality Matching Rule

JSON Equality Matching Rules determine whether two JSON values are equivalent using a custom set of rules.

It is possible to select which JSON fields should be used for matching as well as whether those fields, if they are strings, should be normalized first by trimming white space and/or ignoring case differences.

## Parent

The JSON Equality Matching Rule object inherits from [Schema Provider](objects-schema-provider.html).

## JSON Equality Matching Rule properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                                                                                                                                                                                                          | Advanced Properties       |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [case-sensitive-strings](#case-sensitive-strings) [enabled](#enabled) [ignore-white-space](#ignore-white-space) [json-keys](#json-keys) [matching-rule-name](#matching-rule-name) [matching-rule-oid](#matching-rule-oid) | [java-class](#java-class) |

### Basic properties

Use the `--advanced` option to access advanced properties.

### case-sensitive-strings

|                         |                                                                                      |
| ----------------------- | ------------------------------------------------------------------------------------ |
| *Synopsis*              | Indicates whether JSON string comparisons should be case-sensitive.                  |
| *Default value*         | false                                                                                |
| *Allowed values*        | truefalse                                                                            |
| *Multi-valued*          | No                                                                                   |
| *Required*              | No                                                                                   |
| *Admin action required* | NoneWhen this property is changed, indexes using this matching rule must be rebuilt. |
| *Advanced*              | No                                                                                   |
| *Read-only*             | No                                                                                   |

### enabled

|                         |                                                           |
| ----------------------- | --------------------------------------------------------- |
| *Synopsis*              | Indicates whether the Schema Provider is enabled for use. |
| *Default value*         | None                                                      |
| *Allowed values*        | truefalse                                                 |
| *Multi-valued*          | No                                                        |
| *Required*              | Yes                                                       |
| *Admin action required* | None                                                      |
| *Advanced*              | No                                                        |
| *Read-only*             | No                                                        |

### ignore-white-space

|                         |                                                                                                                                        |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Indicates whether JSON string comparisons should ignore white space.                                                                   |
| *Description*           | When enabled, all leading and trailing white space will be removed and intermediate white space will be reduced to a single character. |
| *Default value*         | true                                                                                                                                   |
| *Allowed values*        | truefalse                                                                                                                              |
| *Multi-valued*          | No                                                                                                                                     |
| *Required*              | No                                                                                                                                     |
| *Admin action required* | NoneWhen this property is changed, indexes using this matching rule must be rebuilt.                                                   |
| *Advanced*              | No                                                                                                                                     |
| *Read-only*             | No                                                                                                                                     |

### json-keys

|                         |                                                                                                               |
| ----------------------- | ------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies which JSON fields should be compared in order to determine whether two JSON objects are equivalent. |
| *Description*           | This parameter is a list of space-delimited JSON pointers.                                                    |
| *Default value*         | None                                                                                                          |
| *Allowed values*        | A non-empty list of space-delimited JSON pointers.                                                            |
| *Multi-valued*          | No                                                                                                            |
| *Required*              | Yes                                                                                                           |
| *Admin action required* | NoneWhen this property is changed, indexes using this matching rule must be rebuilt.                          |
| *Advanced*              | No                                                                                                            |
| *Read-only*             | No                                                                                                            |

### matching-rule-name

|                         |                                            |
| ----------------------- | ------------------------------------------ |
| *Synopsis*              | The name of the custom JSON matching rule. |
| *Default value*         | The matching rule will not have a name.    |
| *Allowed values*        | A string.                                  |
| *Multi-valued*          | No                                         |
| *Required*              | No                                         |
| *Admin action required* | None                                       |
| *Advanced*              | No                                         |
| *Read-only*             | No                                         |

### matching-rule-oid

|                         |                                                   |
| ----------------------- | ------------------------------------------------- |
| *Synopsis*              | The numeric OID of the custom JSON matching rule. |
| *Default value*         | None                                              |
| *Allowed values*        | The OID of the matching rule.                     |
| *Multi-valued*          | No                                                |
| *Required*              | Yes                                               |
| *Admin action required* | None                                              |
| *Advanced*              | No                                                |
| *Read-only*             | No                                                |

## Advanced properties

Use the `--advanced` option to access advanced properties.

### java-class

|                         |                                                                                                                    |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------ |
| *Synopsis*              | Specifies the fully-qualified name of the Java class that provides the JSON Equality Matching Rule implementation. |
| *Default value*         | org.opends.server.schema.JsonEqualityMatchingRuleProvider                                                          |
| *Allowed values*        | A Java class that extends or implements:- org.opends.server.schema.SchemaProvider                                  |
| *Multi-valued*          | No                                                                                                                 |
| *Required*              | Yes                                                                                                                |
| *Admin action required* | None                                                                                                               |
| *Advanced*              | Yes                                                                                                                |
| *Read-only*             | No                                                                                                                 |