Person
A person object is the digital representation of a person within the Netsocs ecosystem. It acts as an identity entity: it concentrates the attributes that identify an individual and serves as a linkage point for other objects (readers, trackers, doors, notifiers) that need to associate their events or states with a specific person.
Think of the person object as a living identity card within the system. On its own it generates no events and does not change state, but it enables the rest of the ecosystem to respond in a personalized way: granting access to a specific door, sending a notification to the owner of a tracked vehicle, or recording who triggered an alarm.
Main characteristics¶
- Identity carrier: Stores and exposes the attributes that identify the person (name, credentials, roles, etc.) through custom state properties.
- No predefined states: The object has no lifecycle of its own; its function is to be referenced by other objects and automations.
- No predefined actions: It does not accept direct commands; it is a data object, not a control object.
- Extensible: Drivers can add arbitrary state properties to enrich the person's profile according to system needs.
Common use cases¶
- Access control: Link a person to a reader or door to record who entered and when.
- Named tracking: Associate a
relative_trackerorgps_trackerwith a person to track their position by name. - Personalized notifications: Use the
personobject as the target in automations that send individual-specific alerts. - Identity management: Centralize person data (employees, visitors, contractors) from external systems such as LDAP directories, Active Directory, or HR databases.
- Audit and traceability: Correlate system events with the identity of the people involved for compliance purposes.
State properties¶
The person object does not define fixed state properties in the SDK. Properties are managed entirely by the driver that implements it, adapting to the data available in each integration.
Examples of common properties a driver may register:
| Property | Description |
|---|---|
name |
Full name of the person. |
email |
Email address. |
department |
Department or organization the person belongs to. |
credential_id |
Access credential identifier (card, PIN). |
role |
Permission role or profile of the person. |