# 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. This structure is temporary/experimental. It will be changed before 4.5 release.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
order | property int | [0,1] | Order in which this correlator is to be evaluated.
ref | property string | [0,1] | Reference to an upstream definition of correlator.
name | property string | [0,1] | Name of the correlator.
displayName | property string | [0,1] |
description | property string | [0,1] |
documentation | property string | [0,1] |
sorLabel | property string | [0,1] | Label for this System of Record.
sorIdentifierAttribute | property QName | [0,1] | Attribute that is sent as SOR identifier.
useReturnedValuesAsBase | property boolean | [0,1] | If true, then values returned from ID Match service (i.
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 CorrelatorsType | [0,1] | The correlator that is applied to the resolved reference identifier provided by the ID Match service.

- ### Items

  - #### order

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Order in which this correlator is to be evaluated. (Related to other correlators.) Smaller numbers go first. Entries with no order go last.

  - #### ref

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Reference to an upstream definition of correlator. It is used as a template for this correlator. TODO refine this specification TODO implement

  - #### 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]

  - #### sorLabel

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Label for this System of Record. Default is "sor" (TODO revise the default).

  - #### sorIdentifierAttribute

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Attribute that is sent as SOR identifier. Default is "icfs:uid". (TODO revise the default. Is it possible for it to be the current primary identifier?)

  - #### useReturnedValuesAsBase

    Flags: RAM,runtime

    Multiplicity: [0,1]

    If true, then values returned from ID Match service (i.e. name-normalized and filtered) are presented to the user as attribute values of the account that is to be correlated. If false (the default), values from midPoint (i.e. original ones) are used. This option is here just to experiment with various approaches in midPoint 4.5-M1.

  - #### 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: RAM,runtime

    Multiplicity: [0,1]

    The correlator that is applied to the resolved reference identifier provided by the ID Match service. It should be strictly synchronous.