This control can be included in a search result entry in response to a join request control in order to provide a set of entries that are related to that search result entry. The control has an OID of 1.3.6.1.4.1.30221.2.5.9, and it takes a value. The following fields may be present in the value-json representation of the value:

• result-code: An integer field whose value is the numeric representation of the LDAP result code for the join processing.

• matched-dn: An optional string field that can be used to provide a matched DN for the join processing. If the join base entry does not exist, this may be the closest ancestor to that entry that actually does exist.

• diagnostic-message: An optional string field that can be used to provide additional information about the join processing.

• referral-urls: An optional array field whose values are strings that represent referral URLs encountered while resolving the join base entry.

• joined-entries: An array field whose values are JSON objects that represent entries that were joined with the search result entry. The format of these JSON objects is essentially the same as the format used for search result entries in the Directory REST API, with the string “_dn” field used to hold each entry’s DN, and a separate string array field for each attribute in the entry. If there are nested join results, then the “_nested-join-results” array field may provide a set of JSON objects whose values are the entries joined with that join entry, using the same fields as the joined-entries field (including another “_nested-join-results” field, if appropriate).

The following represents an example JSON encoding for the control:

{ "oid":"1.3.6.1.4.1.30221.2.5.9",
  "control-name":"Join Result Control",
  "criticality":false,
  "value-json":{ "result-code":0,
                 "joined-entries":[ { "_dn":"uid=jdoe,ou=People,dc=example,dc=com",
                                      "uid":[ "jdoe" ],
                                      "givenName":[ "John" ],
                                      "sn":[ "Doe" ],
                                      "cn":[ "John Doe" ],
                                      "mail":[ "jdoe@example.com" ] } ] } }