ShadowType (Complex Type)

Items

• name

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Human-readable, mutable name of the object. It may also be an identifier (login name, group name). It is usually unique in the respective context of interpretation. E.g. the name of the UserType subtype is usually unique in the whole system. The name of the ShadowType subtype is usually unique in the scope of resource (target system) that it belongs to.

  The name may not be human-readable in a sense to display to a common end-user. It is intended to be displayed to IDM system administrator. Therefore it may contain quite a "ugly" structures such as LDAP DN or URL.

  Name is mutable. It is considered to be ordinary property of the object. Therefore it can be changed by invoking usual modifyObject operations. However, change of the name may have side effects (rename process).

  Although name is specified as optional by this schema, it is in fact mandatory for most object types. The reason for specifying the name as optional is that the name may be generated by the system instead of supplied by the clients. However, all objects stored in the repository must have a name.

• description

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Free-form textual description of the object. This is meant to be displayed in the user interface.

• fetchResult

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Result of the operation that fetched this instance of the object. It is mostly used to indicate that the object is not complete or there is some problem with the object. This is used instead of exception if the object is part of larger structures (lists as in list/search operations or composite objets). If not present then the "SUCCESS" state is assumed.

  This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

• extension

  Flags: dyn,RAM,runtime

  Multiplicity: [0,1]

  Extension container that provides generic extensibility mechanism. Almost any extension property can be placed in this container. This mechanism is used to extend objects with new properties. The extension is treated exactly the same as other object properties by the code (storage, modifications, etc), except that the system may not be able to understand their meaning.

• parentOrgRef

  Flags: RAM

  Multiplicity: [0,-1]

  Set of the orgs (organizational units, projects, teams) that the object relates to. This usually means that the object belongs to them but it may have other meanings as well (e.g. user manages an organizational unit).

• trigger

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  Defines triggers for an object. Trigger is an action that should take place at specified time or under some other condition.

• metadata

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Meta-data about object creation, modification, etc.

• tenantRef

  Flags: RAM

  Multiplicity: [0,1]

  Reference to the tenant to which this object belongs. It is a computed value set automatically by midPoint. It is determined from the organizational structure. Even though this value is compted it is also stored in the repository due to performance reasons.

• resourceRef

  Flags: RAM

  Multiplicity: [0,1]

  Resource that this resource object shadow belongs to.

• result

  Flags: RAM,runtime

  Multiplicity: [0,1]

• objectChange

  Flags: RAM,runtime

  Multiplicity: [0,1]

• attemptNumber

  Flags: RAM,runtime

  Multiplicity: [0,1]

• failedOperationType

  Flags: RAM,runtime,AVals:4

  Multiplicity: [0,1]

• dead

  Flags: RAM,runtime

  Multiplicity: [0,1]

• synchronizationSituation

  Flags: RAM,runtime,AVals:5

  Multiplicity: [0,1]

• synchronizationTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

• fullSynchronizationTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

• synchronizationSituationDescription

  Flags: RAM,runtime

  Multiplicity: [0,-1]

• objectClass

  Flags: RAM,runtime

  Multiplicity: [1,1]

• auxiliaryObjectClass

  Flags: RAM,runtime

  Multiplicity: [0,-1]

• kind

  Flags: RAM,runtime,AVals:3

  Multiplicity: [0,1]

• intent

  Flags: RAM,runtime

  Multiplicity: [0,1]

• protectedObject

  Flags: RAM,runtime

  Multiplicity: [0,1]

• ignored

  Flags: RAM,runtime

  Multiplicity: [0,1]

• assigned

  Flags: RAM,runtime

  Multiplicity: [0,1]

• exists

  Flags: RAM,runtime

  Multiplicity: [0,1]

• iteration

  Flags: RAM,runtime

  Multiplicity: [0,1]

• iterationToken

  Flags: RAM,runtime

  Multiplicity: [0,1]

• attributes

  Flags: dyn,RAM,runtime

  Multiplicity: [0,1]

  Attribute values from the resource. The values may be freshly fetched from the resource or cached. The set of attributes may be empty, may provide a complete copy of the resource object or anything in between. This depends on the implementation of the caching and fetching strategy, configuration of the provisioning subsystem or operation that was invoked. When this object is stored, attribute set will contain attribute values that are (persistently) cached from the resource. In the normal case, there should be at least attributes that identify the resource object on the resource (identifiers). This will be a single attribute in a normal case, something like uid, username, DN, etc. But if a single attribute is not enough to identify the account, more than one attribute may be present. There also may be no attributes. This can happen e.g. if IDM system knows that user should have account on the resource, but the account is not yet created and no identifier is yet assigned to it. This schema does not distinguish which attributes are identifiers and which are ordinary attributes. That can be learned from the resource schema provided by resource or resource connector. Motivation: Resource schema is dynamic, the attribute that is identifier for a specific object may be different for different resources, even if the resources are of the same type (e.g. directory servers with different LDAP schema). And we do not really need to know which of the attributes is identifier in the compile-time. Knowing that in run-time is enough. Please note that this may be out of sync with regard to the resource. In some operations (e.g. lookup) it will be only milliseconds old, but in case of stored cached values this may be days or even weeks old value. Even though there is a single extensible element "attributes", we do not want to put its content directly to the body of resource object. Doing so will cause problems with UPA rule and it will effectively prohibit the the of type replacement extensibility on this object.

• association

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  TODO

• activation

  Flags: RAM,runtime

  Multiplicity: [0,1]

  TODO For more details see the ActivationType documentation.

• credentials

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The set of account credentials (such as passwords).

• cachingMetadata

  Flags: RAM,runtime

  Multiplicity: [0,1]