Skip to content

barrier:access_granted

The barrier:access_granted event is emitted when an request to access a barrier was granted. A request can be made by an authenticated subject (identity) or an anonymous subject. The data available in this event depends on whether the request was made by an authenticated or anonymous subject.

Event specific attributes

  • Access point ID (name: accessPointId, type: string:UUIDv6)
  • Access point name (name: accessPointName, type: string)
  • Access point direction (name: accessPointDirection, type: string:enum, values: in|out)
  • Subject code (name: subjectCode, type: string:enum, values: identity|anonymous)
  • Subject data (name: subjectData, type: object)

Anonymous subject

When the subject code is anonymous, the subject data object will be an empty object.

Identity subject

When the subject code is identity, the subject data object will have the following attributes:

  • Identity ID (name: identityId, type: string)
  • Identity name (name: identityname, type: string)

Payload example

json
{
    "eventTopic": "barrier",
    "eventCode": "access_granted",
    "eventDescription": "Authenticated access granted",
    "eventOccurred": "2023-09-07T10:18:41+02:00",
    "eventId": "1ee4d572-7b62-6136-86c8-35b55032bfe2",
    "eventData": {
        "barrierId": "6630e036-ee13-11ef-bc15-b33a54d715fa",
        "barrierName": "The barrier name",
        "barrierDescription": "The barrier description",
        "deviceId": "0eeb5774-e88d-11ef-95f8-afbaa9403ab9",
        "deviceName": "The controller name",
        "deviceDescription": "The controller description",
        "siteId": "182140d9-d99c-4dc8-ae14-0071a01d7e98",
        "siteName": "The site name",
        "siteDescription": "The site description",
        "groupId": "cf84e116-ee61-4bd8-b078-3d2fadfcc9ac",
        "groupName": "The alarm group name",
        "groupDescription": "The alarm group description",
        "groupActive": true,
        "groupState": "schedule",
        "accessPointId": "2ae08586-2e91-11f0-a3e4-b31dae4d786f",
        "accessPointName": "Reader A1",
        "accessPointDirection": "in",
        "subjectCode": "identity",
        "subjectData": {
          "identityId": "f85f1cbe-ee1a-11ef-ab90-cb1652ddbbc5",
          "identityName": "The identity name"
        }
    }
}

This site is in beta and under active development. Links may break.