# IdMatchCorrelatorType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Supertype: AbstractCorrelatorType
Correlation using ID Match service. See https://spaces.at.internet2.edu/display/cifer/SOR-Registry+Strawman+ID+Match+API.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Name of the correlator.
displayName | property string | [0,1] |
description | property string | [0,1] |
documentation | property string | [0,1] |
confidence | container CorrelationConfidenceDefinitionType | [0,1] | Defines how this correlator - if matching - increases the overall confidence of its results.
enabled | property boolean | [0,1] | A way how to disable a correlator (either temporarily, or e.
super | container SuperCorrelatorReferenceType | [0,1] | Reference to the "super-correlator", serving as a template for this correlator.
sorLabel | property string | [0,1] | Label for this System of Record.
sorIdentifierPrefix | property string | [0,1] | First part of the SOR identifier.
sorIdentifierProperty | property ItemPathType | [0,1] | Attribute whose value provides the base of the SOR identifier.
url | property string | [0,1] | ID Match service URL.
username | property string | [0,1] | User (login) name used to connect to the service.
password | property ProtectedStringType | [0,1] | Password used to connect to the service.
followOn | container CompositeCorrelatorType | [0,1] | The correlator that is applied to the resolved (or potentially-matching) reference identifier provided by the ID Match service.
referenceIdProperty | property ItemPathType | [0,1] | Where (in the focus object) the reference ID property should be stored.
correlationProperties | container IdMatchCorrelationPropertiesType | [0,1] | What properties should be sent to the ID Match service.
candidateConfidenceLimit | property double | [0,1] | Maximum confidence value that is acceptable for the given candidate.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Name of the correlator. Should be unique in the given context (object type definition, resource, or system-wide).

  - #### displayName

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### confidence

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Defines how this correlator - if matching - increases the overall confidence of its results.

  - #### enabled

    Flags: RAM,runtime

    Multiplicity: [0,1]

    A way how to disable a correlator (either temporarily, or e.g. for sub-types).

  - #### super

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Reference to the "super-correlator", serving as a template for this correlator.

  - #### sorLabel

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Label for this System of Record. Default is "midpoint".

  - #### sorIdentifierPrefix

    Flags: RAM,runtime

    Multiplicity: [0,1]

    First part of the SOR identifier. Used to distinguish between various source systems with overlapping primary ID spaces.

  - #### sorIdentifierProperty

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Attribute whose value provides the base of the SOR identifier. Default is the primary identifier in the shadow.

  - #### url

    Flags: RAM,runtime

    Multiplicity: [0,1]

    ID Match service URL.

  - #### username

    Flags: RAM,runtime

    Multiplicity: [0,1]

    User (login) name used to connect to the service.

  - #### password

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Password used to connect to the service.

  - #### followOn

    Flags: elaborate,RAM,runtime

    Multiplicity: [0,1]

    The correlator that is applied to the resolved (or potentially-matching) reference identifier provided by the ID Match service. It should be the single one (no composition), and must not return uncertain results: only "existing (single) owner" and "no owner" answers are accepted. REMOVED: Please use "referenceIdProperty" instead.

  - #### referenceIdProperty

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Where (in the focus object) the reference ID property should be stored. The property must be indexed, i.e. searchable for; and it must be loaded by default (majority of properties are loaded by default; exceptions are e.g. jpegPhoto). Examples: extension/referenceId, employeeNumber. Do not specify any variable like $focus.

  - #### correlationProperties

    Flags: RAM,runtime

    Multiplicity: [0,1]

    What properties should be sent to the ID Match service. Default: All pre-focus properties.

  - #### candidateConfidenceLimit

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Maximum confidence value that is acceptable for the given candidate. If the ID Match service provides a higher value, it is cropped to this one. (The same is true if ID Match provides no value.)