Siemens SiPort REST
Siemens·AE_HSc_SIPORT_RestConnectorGuide
Overview
The SiPort REST connector integrates AlertEnterprise Guardian with Siemens SiPort 2.0+ via SiPort's modern RESTful API — replacing the legacy Personnel Data Import path used by siemens-siport. This is the recommended connector for new SiPort deployments on supported versions.
The architecture is direct: AE → SIPORT REST Connector → SIPORT RESTful API → SIPORT System. The connector uses AE's generic REST connector framework (com.alnt.platform.core.connector.rest.commons.IRESTConnectorInterface) with per-operation endpoint URLs configured as System Parameters. Unlike the legacy path, provisioning is real-time — no Windows service polling, no batch import latency.
This is a newer connector — first revision dated 2026-01-29, so coverage and field-mapping conventions are still settling. Verify against the latest guide revision during deployment.
Architecture
Composed from this connector's actors + edges. Trust zones are color-coded; trust crossings render as thicker lines.
Authentication
1 method supported
Authentication to the SiPort REST API uses username + password configured as System Parameters. The connector's Authorization parameter holds the bearer/token if the deployment layers token auth atop basic. Example Instance URL from the connector guide: https://192.168.194.85:8043.
Endpoints
10 endpoints exercised by the connector
| Method | Path | Description | Category |
|---|---|---|---|
| POST | {CREATE_USER0 endpoint} | Create User Account. | provisioning |
| PUT | {UPDATE_USER0 endpoint} | Update User Information. | provisioning |
| DELETE | {DELETE_USER0 endpoint} | Delete User Account. | deprovisioning |
| POST | {LOCK_USER0 endpoint} | Lock User Account. | lifecycle |
| POST | {UNLOCK_USER0 endpoint} | Unlock User Account. | lifecycle |
| POST | {ASSIGN_BADGE0 endpoint} | Assign Credential. | provisioning |
| PUT | {UPDATE_BADGE0 endpoint} | Update Card information. | provisioning |
| POST | {ACTIVATE_BADGE0 endpoint} | Activate Credential. | lifecycle |
| POST | {DEACTIVATE_BADGE0 endpoint} | Deactivate Credential. | lifecycle |
| DELETE | {REMOVE_BADGE0 endpoint} | Delete Credential. | deprovisioning |
Prerequisites
Everything that must be in place for this connector to work, with the owner who's responsible.
Siemens SiPort 2.0+ with REST API enabled
customerAn operational Siemens SiPort 2.0 or later deployment with the REST API enabled. The Instance URL system parameter must point to the API base.
SiPort REST API user account
customerA dedicated SiPort REST API user account with provisioning + reconciliation privileges.
Per-operation endpoint URLs configured
aeEach operation endpoint must be configured as a System Parameter: CREATE_USER0, UPDATE_USER0, DELETE_USER0, LOCK_USER0, UNLOCK_USER0, ASSIGN_BADGE0, UPDATE_BADGE0, ACTIVATE_BADGE0, DEACTIVATE_BADGE0, REMOVE_BADGE0.
Run Database Scripts in HSC Application Table
aePer the connector guide's Chapter 3 installation, database scripts must be executed in the HSC application table for the connector to function correctly.
Known limitations
Documented constraints to set customer expectations before deployment.
New connector — verify against latest guide revision
informationalFirst revision dated January 2026 — coverage and field-mapping conventions are still settling. Re-verify against the latest connector guide revision before each new deployment and after each SiPort upgrade.
PACS specifics
SiPort cardholders modeled via REST resources with associated credentials.
SiPort access via Profiles (same naming as siemens-siport), exposed through REST.
Single SiPort instance per AE→SiPort REST connector.
- Topology
- on-prem
- Event model
- polling
- Anti-passback
- unknown
- Holiday schedules
- unknown
- src/connectors/siport-rest/source.pdf — Full connector guide — 56 pages, first revision dated 2026-01-29
- src/connectors/siport-rest/source.pdf — p6 — Supported Version
- src/connectors/siport-rest/source.pdf — p7 — Connector Architecture