User list

Users in your identity directory and operational systems.

Part of Counterparties in the register catalog.

Register ID: user_listUse this name to ask for the register. The API calls it a shelf ID.
Each record is: A stateThe current value of something, replaced when it changes.
Status: AvailableFilled today from connected systems, uploads or public data.
Data: OrganisationPrivate to each organisation's own workspace.
Version: v1Current version.

Download JSON Schema See an example record

Standards

This register holds records these standards and laws ask for. Holding them does not by itself certify compliance.

ISO 30414Human capital reportingInternational · Clauses 1, 3
Fair Work Act 2009National employment standards and modern awardsAustralia

Connectors

Connected today

Demiton keeps this register current from these systems now.

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

EROADPartial
Geotab
HammerTech
MapTrack
Mitti
MYOB BusinessPartial
Oracle Aconex
PayappsPartial
Procore
SitematePartial
Xero AccountingPartial
Xero Payroll AUPartial

Fields

13 fields: 4 required, 9 optional.

Required

Every record carries these fields.

worker_entity_idWhole number

Demiton canonical worker spine node this fact anchors to (the subject)

Example: 5501

source_systemText

The bound system that produced this row.

Example: SHAREPOINT

source_external_idText

The raw record id in the producing system, scoped to source_system

Example: a1b2c3d4-0001-4a2b-9c3d-000000000001

display_nameText

The person's display name.

Example: Aaron Patel

Optional

Present when the source system records them.

user_principal_nameText

Directory sign-in name (Entra UPN)

Example: aaron.patel@bridgeworksgroup.example.com

emailText

Email address used as the cross-source identity bridge.

Example: aaron.patel@example.com

account_enabledTrue or false

Whether the source account is currently enabled/active.

Example: true

job_titleText

Role/job title in the owning organisation.

Example: Site Supervisor

departmentText

Organisational unit the account belongs to.

Example: Operations

work_locationText

Location associated with the account (city/site/suburb)

phoneText

Contact phone number.

identity_kindText

The source's own classification of the account, where it exposes one.

source_created_atDate and timeISO 8601, with time zone

When the source record was created (freshness)

Example record

A sample from Bridgeworks Group, Demiton's demonstration company. The values are illustrative; the shape is exactly what the contract describes.

{
  "account_enabled": true,
  "department": "Operations",
  "display_name": "Aaron Patel",
  "email": "aaron.patel@example.com",
  "job_title": "Site Supervisor",
  "source_external_id": "a1b2c3d4-0001-4a2b-9c3d-000000000001",
  "source_system": "SHAREPOINT",
  "user_principal_name": "aaron.patel@bridgeworksgroup.example.com",
  "worker_entity_id": 5501
}

Use this contract

The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.

https://docs.demiton.io/registers/user_list/v1.json

Show the full JSON Schema

Loading the schema…

Talk to the team

Tell us what you run - your ERP, field, payroll and document systems - and we will show you the registers Demiton would keep current from them, on your data, in a 30-minute call.

Book a 30-minute call Start free