LockEventSettingsV1
Information regarding the device beeper settings and action to modify them.
Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows
LockEventSettingsV1SetLockSettings action
Modify writable lock settings states.
Mutation Inputs
Input Name | Description | Data Type | Nullable |
deviceId | uuid of the device to which mutation should apply | ID! | false |
traitActionArgs | See table below for specific fields. | LockEventSettingsV1SetLockSettingsArgs! | false |
LockEventSettingsV1SetLockSettingsArgs Fields
Field Name | Description | Data Type | Nullable |
unauthorizedUserEventEnabled | Desired value for the unauthorizedUserEventEnabled setting. | unauthorizedUserEventEnabledEnum | true |
rexEventEnabled | Desired value for the rexEventEnabled setting. | rexEventEnabledEnum | true |
interiorLockBlinkingEnabled | Desired value for the interiorLockBlinkingEnabled setting. | interiorLockBlinkingEnabledEnum | true |
powerFailLockMode | Desired value for the powerFailLockMode setting. | powerFailLockModeEnum | true |
blockConstructionModeEnabled | Desired value for the blockConstructionModeEnabled setting. | blockConstructionModeEnabledEnum | true |
doubleTapEnabled | Desired value for the doubleTapEnabled setting. | doubleTapEnabledEnum | true |
keyOverrideEventEnabled | Desired value for the keyOverrideEventEnabled setting. | keyOverrideEventEnabledEnum | true |
bruteForceMitigationSetting | Desired value for the bruteForceMitigationSetting setting. | bruteForceMitigationSettingEnum | true |
unauthorizedUserEventEnabledEnum Values
Enumerated Value | Description |
ENABLED | unauthorizedUserEventEnabled will publish notification. |
DISABLED | unauthorizedUserEventEnabled will not publish notification. |
rexEventEnabledEnum Values
Enumerated Value | Description |
ENABLED | rexEventEnabled will publish notification. |
DISABLED | rexEventEnabled will not publish notification. |
interiorLockBlinkingEnabledEnum Values
Enumerated Value | Description |
NORMALBLINKENABLED | Interior LED blinks normally when device is secured. |
RAPIDBLINKENABLED | Interior LED blinks rapidly when device is secured. |
DISABLED | Interior LED does not blink when device secured. |
powerFailLockModeEnum Values
Enumerated Value | Description |
AS_IS | Device will remain in whichever state it was in when power was lost. |
FAILSECURE | Device will always revert to secured state on loss of power. |
FAILPASSAGE | Device will always revert to passage state on loss of power. |
blockConstructionModeEnabledEnum Values
Enumerated Value | Description |
ENABLED | Device blockConstruction mode is enabled. |
DISABLED | Device blockConstruction mode is disabled. |
doubleTapEnabled Values
Enumerated Value | Description |
ENABLED | Device doubleTapEnabled mode is enabled. |
DISABLED | Device doubleTapEnabled mode is disabled. |
keyOverrideEventEnabledEnum Values
Enumerated Value | Description |
ENABLED | keyOverrideEventEnabled will publish notification. |
DISABLED | keyOverrideEventEnabled will not publish notification. |
bruteForceMitigationSettingEnum Values
Enumerated Value | Description |
ENABLED | Device will block credential authentications under a brute force attack scenario. |
DISABLED | Device will not block credential authentications under a brute force attack scenario. |
GQL Examples
Request Example
mutation LockEventSettingsV1SetLockSettings {
LockEventSettingsV1SetLockSettings(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: {
unauthorizedUserEventEnabled: ENABLED
rexEventEnabled: ENABLED
interiorLockBlinkingEnabled: NORMALBLINKENABLED
powerFailLockMode: AS_IS
blockConstructionModeEnabled: ENABLED
doubleTapEnabled: ENABLED
keyOverrideEventEnabled: ENABLED
bruteForceMitigationSetting: ENABLED
}
) {
deviceId
actionId
traitName
}
}
Response Example
{
"data": {
"LockEventSettingsV1SetLockSettings": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}
Reported States
Note: See Overview: Device Reported State for more information on reported state flows.
State Definitions
unauthorizedUserEventEnabled state
Setting to determine if notification should publish when unauthorized user attempts to gain entry.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | unauthorizedUserEventEnabled will publish notification. |
DISABLED | unauthorizedUserEventEnabled will not publish notification. |
UNSUPPORTED | Device has not yet reported a value for this field. |
rexEventEnabled state
Setting to determine if notification should publish when request to exit switch is triggered.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | rexEventEnabled will publish notification. |
DISABLED | rexEventEnabled will not publish notification. |
UNSUPPORTED | Device has not yet reported a value for this field. |
interiorLockBlinkingEnabled state
Setting that determines how the device LED blinks when device is secured.
Data Type: Enum
Valid Values
Enumerated Value | Description |
NORMALBLINKENABLED | Interior LED blinks normally when device is secured. |
RAPIDBLINKENABLED | Interior LED blinks rapidly when device is secured. |
DISABLED | Interior LED does not blink when device secured. |
UNSUPPORTED | Device has not yet reported a value for this field. |
powerFailLockMode state
Setting that determines which state lock will default to upon loss of power.
Data Type: Enum
Valid Values
Enumerated Value | Description |
AS_IS | Device will remain in whichever state it was in when power was lost. |
FAILSECURE | Device will always revert to secured state on loss of power. |
FAILPASSAGE | Device will always revert to passage state on loss of power. |
UNSUPPORTED | Device has not yet reported a value for this field. |
blockConstructionModeEnabled state
Setting that determines if device blockConstruction mode is enabled to prevent device from being put into construction mode.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | Device blockConstruction mode is enabled. |
DISABLED | Device blockConstruction mode is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
doubleTapEnabled state
Setting that determines if device doubleTap mode is enabled to allow normal credential to toggle device secured/passage state when double tapped to reader.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | Device doubleTapEnabled mode is enabled. |
DISABLED | Device doubleTapEnabled mode is disabled. |
UNSUPPORTED | Device has not yet reported a value for this field. |
keyOverrideEventEnabled state
Setting to determine if notification should publish when entry was gained via key override.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | keyOverrideEventEnabled will publish notification. |
DISABLED | keyOverrideEventEnabled will not publish notification. |
UNSUPPORTED | Device has not yet reported a value for this field. |
bruteForceMitigationSetting state
Setting to determine if device should block credential authentications under a brute force attack scenario.
Data Type: Enum
Valid Values
Enumerated Value | Description |
ENABLED | Device will block credential authentications under a brute force attack scenario. |
DISABLED | Device will not block credential authentications under a brute force attack scenario. |
UNSUPPORTED | Device has not yet reported a value for this field. |
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d") {
id
traits {
... on LockEventSettingsV1DeviceTrait {
name
state {
unauthorizedUserEventEnabled {
reported {
value
}
}
rexEventEnabled {
reported {
value
}
}
interiorLockBlinkingEnabled {
reported {
value
}
}
powerFailLockMode {
reported {
value
}
}
blockConstructionModeEnabled {
reported {
value
}
}
doubleTapEnabled {
reported {
value
}
}
keyOverrideEventEnabled {
reported {
value
}
}
bruteForceMitigationSetting {
reported {
value
}
}
}
}
}
}
}
Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "LockEventSettingsV1",
"state": {
"unauthorizedUserEventEnabled": {
"reported": {
"value": "DISABLED"
}
},
"rexEventEnabled": {
"reported": {
"value": "UNSUPPORTED"
}
},
"interiorLockBlinkingEnabled": {
"reported": {
"value": "RAPIDBLINKENABLED"
}
},
"powerFailLockMode": {
"reported": {
"value": "FAILSECURE"
}
},
"blockConstructionModeEnabled": {
"reported": {
"value": "DISABLED"
}
},
"doubleTapEnabled": {
"reported": {
"value": "DISABLED"
}
},
"keyOverrideEventEnabled": {
"reported": {
"value": "ENABLED"
}
},
"bruteForceMitigationSetting": {
"reported": {
"value": "DISABLED"
}
}
}
}
]
}
}
}On this page
- LockEventSettingsV1