# 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
--- | --- | --- | ---
definitions | container CorrelatorDefinitionsType | [0,1] | TODO
order | property int | [0,1] | Order in which this correlator is to be evaluated.
authority | property CorrelatorAuthorityLevelType | [0,1] | TODO
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.
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.

- ### Items

  - #### definitions

    Flags: RAM,runtime

    Multiplicity: [0,1]

    TODO

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

  - #### authority

    Flags: RAM,runtime,AVals:3

    Multiplicity: [0,1]

    TODO

  - #### 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 "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 "$shadow/icfs:uid". (TODO revise the default. Is it possible for it to be the current primary identifier?)

  - #### 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 strictly synchronous.