--- title: Name And JSON Query Equality Matching Rule description: "The Name And JSON Query Equality Matching Rule Provider provides the ability to configure customized JSON query equality matching rules…​ (WARNING: private interface)" component: pingds version: 8.1 page_id: pingds:configref:objects-name-and-json-query-equality-matching-rule canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-name-and-json-query-equality-matching-rule.html section_ids: parent: Parent name_and_json_query_equality_matching_rule_properties: Name And JSON Query Equality Matching Rule properties basic_properties: Basic properties case-sensitive-strings: case-sensitive-strings enabled: enabled ignore-white-space: ignore-white-space indexed-field: indexed-field matching-rule-name: matching-rule-name matching-rule-oid: matching-rule-oid advanced_properties: Advanced properties java-class: java-class --- # Name And JSON Query Equality Matching Rule The Name And JSON Query Equality Matching Rule Provider provides the ability to configure customized JSON query equality matching rules…​ (WARNING: private interface) The core schema provides a default 'Name And JSON' equality matching rule for Name and JSON values which match the DN and the JSON strings according to the LDAP 'caseIgnoreMatch' semantics (i.e trim white space and ignore case differences), as well as the indexing of all JSON fields. This schema provider allows users to create custom Name and JSON matching rules which may only index a restricted set of JSON fields, thereby consuming less backend resources. ## Parent The Name And JSON Query Equality Matching Rule object inherits from [Schema Provider](objects-schema-provider.html). ## Name And JSON Query 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) [indexed-field](#indexed-field) [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* | None | | *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* | None | | *Advanced* | No | | *Read-only* | No | ### indexed-field | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies which JSON fields should be indexed. | | *Description* | A field will be indexed if it matches any of the configured field patterns. | | *Default value* | All JSON fields will be indexed. | | *Allowed values* | A JSON pointer which may include wild-cards. A single '\*' wild-card matches at most a single path element, whereas a double '\*\*' matches zero or more path elements. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *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 Name And JSON Query Equality Matching Rule implementation. | | *Default value* | org.opends.server.schema.NameAndJsonQueryEqualityMatchingRuleProvider | | *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 |