NodeType (Object Definition)

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.

• documentation

  Flags: RAM,runtime

  Multiplicity: [0,1]

  AsciiDoc-formatted technical documentation of the object.

• subtype

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Type of the object. It is used to distinguish what a specific object represents. Whether it is a different kind of organizational unit, project, team, or different kind of user, etc.

• 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 objects). 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,oper

  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]

  Triggers for this object. They drive invocations of corresponding trigger handlers at specified time.

• metadata

  Flags: RAM,runtime,oper

  Multiplicity: [0,1]

  Meta-data about object creation, modification, etc.

• tenantRef

  Flags: RAM,oper

  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 computed it is also stored in the repository due to performance reasons.

• lifecycleState

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Lifecycle state of the object. This property defines whether the object represents a draft, proposed definition, whether it is active, deprecated, and so on.

  There are few pre-defined lifecycle states. But custom lifecycle states may also be defined. Pre-defined lifecycle states are:

  • draft: Definition of the new object in progress. The object is NOT active. The definition may change at any moment. It is not ready yet.
  • proposed: Definition of a new object is ready for use, but there is still a review process to be applied (e.g. approval). The object is NOT active. However the definition should not change in this state.
  • active: Active and working definition. Ready to be used without any unusual limitations.
  • deprecated: Active definition which is being phased out. The definition is still fully operational. But it should not be used for new assignments. E.g. it should not be requested, it should not be approved, etc.
  • archived: Inactive historical definition. It is no longer used. It is maintained only for historical, auditing and sentimental reasons.
  • failed: Unexpected error has occurred during object lifecycle. Result of that event is that the object is rendered inactive. The situation cannot be automatically remedied. Manual action is needed.

• operationExecution

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  Description of recent operations executed on this object (or related objects, e.g. shadows in case of a focal object). The number of operations to be kept here is configurable.

• lensContext

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Model context describing executed operation

• policySituation

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  The policy situation(s) of this object. The situations are result of evaluation of the policy rules. This property is recorded for each object and can be used for reporting, diagnostics, target selection in certification campaigns, etc.

• triggeredPolicyRule

  Flags: RAM,runtime,oper

  Multiplicity: [0,-1]

  Triggered policy rules for this assignment. (Not necessarily complete; subject to specified storage strategy.) This is EXPERIMENTAL functionality. It is possibly to change in the near future.

• policyException

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Recorded exception from a policy rule. The exceptions that are approved are recoded here to avoid re-evaluating and re-approving them all the time. This is EXPERIMENTAL functionality. It is likely to change in the near future.

• diagnosticInformation

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  Diagnostic information attached to this object.

• nodeIdentifier

  Flags: RAM,runtime

  Multiplicity: [1,1]

  Short, cluster-wide identifier of the node. It may be a hostname or a short number node ID. Very short string is advised as this identifier is used to generate other identifiers (e.g. lightweight IDs), it is used in audit records, etc.

• hostname

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Hostname of the node that can be used by other nodes to contact this node over the network. It is automatically determined and updated.

• url

  Flags: RAM,runtime

  Multiplicity: [0,1]

  URL of midPoint that can be used by other nodes to contact this node over the network. It is either provided manually (see urlOverride), constructed using infrastructure/intraClusterHttpUrlPattern configuration property, or determined automatically.

• urlOverride

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Value to override constructed or determined URL.

• ipAddress

  Flags: RAM,runtime

  Multiplicity: [0,-1]

  IP addresses of the node (both IPv4 and IPv6 addresses in textual notation)

• jmxPort

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Port at which this node can be contacted via JMX.

• lastCheckInTime

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The time when this node last checked-in.

• operationalStatus

  Flags: RAM,runtime,AVals:4

  Multiplicity: [0,1]

  Basic node operational state: whether it is up (e.g. should be accepting REST/JMX queries), or it is down (known to be turned off or just not checking-in for a longer time), or starting. Does NOT indicate anything about the scheduler status. Supersedes "running" property.

• running

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Whether this node is running, i.e. it can be queried via JMX. (This does not necessarily mean that the scheduler thread and task threads are running!) DEPRECATED. Replaced by operationalState.

• clustered

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Whether this node is a part of a cluster. Used to detect misconfigurations.

• internalNodeIdentifier

  Flags: RAM,runtime

  Multiplicity: [1,1]

  Internal (generated) node identifier, used primarily to detect whether the node information was not overwritten by another node.

• executionStatus

  Flags: RAM,runtime,AVals:7

  Multiplicity: [1,1]

  Actual node status from the point of executing tasks. This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

• errorStatus

  Flags: RAM,runtime,AVals:6

  Multiplicity: [1,1]

  More detailed characterization of the error state. This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

• connectionResult

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Result of the operation that connected to this node. This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

• build

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Information about midPoint build running on this node.

• secret

  Flags: RAM,runtime

  Multiplicity: [0,1]

  The secret used for intra-cluster authentication.

• secretUpdateTimestamp

  Flags: RAM,runtime

  Multiplicity: [0,1]

  When was the secret created or last changed.

• taskExecutionLimitations

  Flags: RAM,runtime

  Multiplicity: [0,1]

  Limitations for execution of tasks on this node.