OpenAccess User Guide - Lenel

1 user GuideLenel OnGuard OpenAccess user GuideThis Guide is item number DOC-1057-EN-US, revision , November 2018. 2018 United Technologies Corporation. All rights , OnGuard , Prism , BlueDiamond , and UltraView are registered trademarks or trademarks of UTC Fire & Security Americas Corporation, Inc. Lenel is a part of UTC Climate, Controls & Security, a unit of United Technologies trademarks are the property of their respective in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the prior express written permission of UTC Fire & Security Americas Corporation, Inc., which such permission may have been granted in a separate agreement ( , end user license agreement or software license agreement for the particular application).Non-English versions of Lenel documents are offered as a service to our global audiences.

2 We have attempted to provide an accurate translation of the text, but the official text is the English text, and any differences in the translation are not binding and have no legal software described in this document is furnished under a license agreement and may only be used in accordance with the terms of that Reports for Windows is a trademark of Business Objects, and FlashPoint are trademarks of Integral Technologies, of this product were created using LEADTOOLS 1991-2011, LEAD Technologies, Inc. ALL RIGHTS RESERVED. Active Directory, Microsoft, SQL Server, Windows, and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other is a registered trademark of Oracle International product names mentioned may be trademarks or registered trademarks of their respective companies and are hereby DOES NOT REPRESENT THAT SOFTWARE, HARDWARE OR RELATED SERVICES MAY NOT BE HACKED, COMPROMISED AND/OR CIRCUMVENTED.

3 Lenel DOES NOT WARRANT THAT SOFTWARE, HARDWARE OR RELATED SERVICES WILL WORK PROPERLY IN ALL ENVIRONMENTS AND APPLICATIONS AND DOES NOT WARRANT ANY SOFTWARE, HARDWARE OR RELATED SERVICES AGAINST HARMFUL ELECTROMAGNETIC INTERFERENCE INDUCTION OR RADIATION (EMI, RFI, ETC.) EMITTED FROM EXTERNAL SOURCES. THE ABILITY OF SOFTWARE, HARDWARE AND RELATED SERVICES TO WORK PROPERLY DEPENDS ON A NUMBER OF PRODUCTS AND SERVICES MADE AVAILABLE BY THIRD PARTIES OVER WHICH Lenel HAS NO CONTROL INCLUDING, BUT NOT LIMITED TO, INTERNET, CELLULAR AND LANDLINE CONNECTIVITY; MOBILE DEVICE AND RELATED OPERATING system COMPATABILITY; OR PROPER INSTALLATION, CONFIGURATION AND MAINTENANCE OF AUTHORIZED HARDWARE AND OTHER MAY MAKE CERTAIN BIOMETRIC CAPABILITIES ( , FINGERPRINT, VOICE PRINT, FACIAL RECOGNITION, ETC.), DATA RECORDING CAPABILITIES ( , VOICE RECORDING), AND/OR DATA/INFORMATION RECOGNITION AND TRANSLATION CAPABILITIES AVAILABLE IN PRODUCTS Lenel MANUFACTURES AND/OR RESELLS.

4 Lenel DOES NOT CONTROL THE CONDITIONS AND METHODS OF USE OF PRODUCTS IT MANUFACTURES AND/OR RESELLS. THE END- user AND/OR INSTALLER AND/OR RESELLER/DISTRIBUTOR ACT AS CONTROLLER OF THE DATA RESULTING FROM USE OF THESE PRODUCTS, INCLUDING ANY RESULTING PERSONALLY IDENTIFIABLE INFORMATION OR PRIVATE DATA, AND ARE SOLELY RESPONSIBLE TO ENSURE THAT ANY PARTICULAR INSTALLATION AND USE OF PRODUCTS COMPLY WITH ALL APPLICABLE PRIVACY AND OTHER LAWS, INCLUDING ANY REQUIREMENT TO OBTAIN CONSENT. THE CAPABILITY OR USE OF ANY PRODUCTS MANUFACTURED OR SOLD BY Lenel TO RECORD CONSENT SHALL NOT BE SUBSTITUTED FOR THE CONTROLLER'S OBLIGATION TO INDEPENDENTLY DETERMINE WHETHER CONSENT IS REQUIRED, NOR SHALL SUCH CAPABILITY OR USE SHIFT ANY OBLIGATION TO OBTAIN ANY REQUIRED CONSENT TO Warnings and DisclaimersTHESE PRODUCTS ARE INTENDED FOR SALE TO, AND INSTALLATION BY, AN EXPERIENCED SECURITY PROFESSIONAL. UTC FIRE & SECURITY CANNOT PROVIDE ANY ASSURANCE THAT ANY PERSON OR ENTITY BUYING ITS PRODUCTS, INCLUDING ANY "AUTHORIZED DEALER", IS PROPERLY TRAINED OR EXPERIENCED TO CORRECTLY INSTALL SECURITY RELATED more information on warranty disclaimers and product safety information, please check or scan the following code: OpenAccess user Guide3 Table of ContentsCHAPTER 1 Introduction.

5 11 Expectations and Behaviors of OpenAccess ..12 Confirming the Installed Version of OnGuard .. 12 Stopping and Restarting the Services .. 12 Authorization .. 12 user -Defined Fields .. 13 OpenAccess and Brute Force Attack Protection .. 13 Using OpenAccess to Issue Mobile Badges .. 13 Authenticated Token and Inactivity Timeouts .. 13 OpenAccess Custom Configuration ..14 Authentication .. 14 Caching Properties .. 15 Badge Printing Properties .. 16 Queuing .. 17 Job Runner/Thread Pool Properties .. 17 Timeout Settings .. 18 Event Context Provider Settings .. 18 Definitions, Acronyms, Abbreviations ..18 OpenAccess Architecture ..19 References and Applicable Documents ..19 CHAPTER 2 Getting Started .. 21 License for OpenAccess ..21 Application ID and Getting Started with Development .. 21 Starting OpenAccess ..22 Stopping and Restarting the Services ..22LS OpenAccess Service ..23 Authorization ..23 Table of Contents4 OpenAccess user GuideAuthentication.

6 24 Deploying the LS Event Context Provider Service .. 24 Enabling Verbose Logging .. 24 Starting the OpenAccess Tool .. 25 Sample Applications .. 25 Sample Web Applications .. 25 Sample C# Applications .. 27 Sample Java Application .. 28 Swagger Specification and Interactive Documentation .. 29 Using Response Headers to Develop Secure Web Applications .. 29 CHAPTER 3 Using OpenAccess .. 31 Searching for Objects .. 31 Date/Time Format .. 32 Date/Time Format When Using OpenAccess API Calls .. 32 Date/Time Format When Using Events .. 32 Binary Format .. 32 String Format .. 33 Features and Limitations .. 33 Cardholders and Visitors .. 33 Badges .. 33 Directory Accounts .. 33 Visits .. 33 user -Defined Fields .. 34 user -Defined List Values .. 34 SegmentID .. 34 Receiving Events .. 35 Durable vs. Transient Event Subscribers .. 35 Using Event Filters with Subscriptions .. 35 Cross-Origin Resource Sharing .. 40 Version.

7 41 OpenAccess and Brute Force Attack Protection .. 41 CHAPTER 4 REST API Reference .. 43 General OpenAccess API Calls .. 44get version .. 44get keepalive .. 45get feature_availability .. 45get queue .. 46get queue/{id} .. 47delete queue/{id} .. 48add partner_values .. 48modify partner_values .. 49 Login and Logout .. 50get directories .. 50add authentication .. 51delete authentication .. 53 OpenAccess user Guide5 Table of Contentsget session .. 54get identity_provider_url .. 55 Receive Events ..56get event_subscriptions .. 56get event_subscriptions with id .. 59add event_subscriptions .. 60modify event_subscriptions with id .. 62delete event_subscriptions with id .. 64 Manage Instances ..65get logged_events .. 65get types .. 69get type .. 70get count .. 73get instances .. 74get print request .. 76add print request .. 78delete print request .. 79get badge mobile_devices .. 80add badge issue_mobile_credential.

8 81get badge printers .. 83add instances .. 84modify instances .. 85bulk modify instance property .. 86delete instances .. 87execute_method .. 88get cardholders .. 89get video_recorders .. 92get auth_data .. 95 Users ..96get logged_in_user .. 96get managed_access_levels .. 97add managed_access_levels .. 98delete managed_access_levels .. 99get user .. 100modify user .. 101put user password .. 102get managers_of_access_level .. 103get editable_segments .. 103get user segments .. 104add user segments .. 106delete user segments .. 107get user preferences .. 107put user preferences .. 109post user preferences .. 110delete user preferences .. 111 Cardholders ..112get cardholder_from_directory .. 112get directory_accounts .. 113get directory_accounts_matching_cardholders .. 114put update_cardholder_with_directory_account _property .. 115 Console ..116post console cards .. 116delete console cards with id .. 118 Table of Contents6 OpenAccess user Guideget console layouts.

9 119put console layouts .. 120 Settings .. 120get authorization warning settings .. 120get cardholder settings .. 122get enterprise settings .. 124get password policy settings .. 126put password policy settings .. 128get segmentation settings .. 131get visit settings .. 132put visit settings .. 133 CHAPTER 5 Event API Reference .. 135 Web Event Bridge Operations .. 135 CreateSubscription .. 135 ModifySubscription .. 137 StopSubscription .. 138 StartManaging .. 139 StopManaging .. 139 Web Event Bridge Client Event Handlers .. 139 OnBusinessEventReceived .. 139 OnExceptionRaised .. 140 OnConnectionFromMessageBusLost .. 140 OnConnectionToMessageBusEstablished .. 140 OnManagementEvent .. 140 Hardware Event Reference .. 141 Access Granted Events .. 144 Access Denied Events .. 145 Area Control Events .. 146 Asset Events .. 146 Biometric Events .. 147 Intercom Events .. 147 Intrusion Events .. 148 Transmitter Events.

10 148 Video Events .. 148 Status Events .. 148 Alarm Acknowledgment Activity Event Reference .. 152 Software Event Reference .. 153 Person Directory Account Events .. 154 Badge Events .. 154 Cardholder Events .. 155 Visitor Events .. 157 Visit Events .. 158 VisitEvent Events .. 158 CHAPTER 6 Data and Association Class Reference .. 161 Data Classes .. 161 Lnl_AccessGroup .. 161 Lnl_AccessLevel .. 162 Lnl_AccessLevelAssignment .. 162 OpenAccess user Guide7 Table of ContentsLnl_AccessLevelManaged .. 163 Lnl_AccessLevelReaderAssignment .. 164 Lnl_AccessRequest .. 165 Lnl_AccessLevelRequest .. 166 Lnl_Account .. 168 Lnl_AlarmAckHistory .. 168 Lnl_AlarmDefinition .. 169 Lnl_AlarmInput .. 171 Lnl_AlarmOutput .. 172 Lnl_AlarmPanel .. 174 Lnl_Area .. 174 Lnl_AuthenticationMode .. 175 Lnl_Badge .. 176 Lnl_BadgeFIPS201 .. 179 Lnl_BadgeLastLocation .. 180 Lnl_BadgeStatus .. 181 Lnl_BadgeType .. 181 Lnl_Camera.