Keyfax
  • πŸ“‹What is Keyfax?
  • Product Suite
    • Keyfax Administrator Tools
      • System Requirements
      • Installation
      • Logging On
      • Navigation
      • Exclusive Mode
      • Script Levels
        • Master Scripts
          • Category Editing
          • Topic Editing
          • Self-Service Categories
        • System Scripts
          • Cancel
          • Priority Justifications
          • Results
          • Special Instructions
          • Startup
        • Script Sets
          • Category Properties
          • Setting up Topics
          • Topic Properties
          • Loading Script Sets
      • Script Editing
        • Script Editing - The basics
        • References
        • Testing your changes
        • Script Flows
      • Script Entities
        • Databoxes
          • Script Data
            • Host-specific notes
          • SQL Query
            • Testing SQL Query Databoxes
          • Import XML
          • Export XML
          • System Values
          • Company Data
          • Testing Databoxes & Expressions
          • Databox Read
          • Databox Write
          • Databoxes in Messages & Tasks
        • Questions
          • Address
          • Checklist
          • Date/Time
          • Dynamic Lists
            • Testing Dynamic Lists
            • Dynamic List Examples
          • External Forms (eForms)
            • External Forms - Technical
          • File Upload
          • List
          • Numeric
          • Text
          • Video Call
        • Asset Data
        • Markers
        • Messages
          • Testing Messages
        • Services
          • Host-specific notes
        • Priorities
        • Tasks
          • Enclosures & Attachments
          • Continuations
          • Host-specific notes
      • Reports
      • Databox Examples
        • Business Days
        • Working Hours
        • Time of day
        • Higher priority jobs
        • Script Duration
        • How did it happen?
        • Repair Description
        • Concatenating CSV
        • Tenant Handbook
        • Multi-line Addresses
        • Priority / Response Days
        • Contains Text
      • Databox Expressions
        • Text Expressions
          • CSV
          • Entry
          • Exists
          • FieldMerge
          • Index
          • IndexOf
          • InList
          • Item
          • Len
          • ListTidy
          • Lower
          • PadLeft
          • Replace
          • Row
          • RowMerge
          • SubStr
          • Trim
          • Upper
          • WCase
        • Numeric Expressions
          • Abs
          • AsNum
          • Between
          • Int
          • Mod
          • Number
          • Result
          • Round
        • Date Expressions
          • After
          • AsDate
          • Before
          • BetweenDates
          • DateAdd
          • Day
          • Month
          • Now
          • Today
          • WeekDay
          • Year
        • Number Formatting
        • Operators And Literals
        • Logical Expressions
        • Additional Functions
          • Ds
      • Users
        • Finding active users
        • Keyfax SSO – via Microsoft Entra ID Support
      • Advanced
        • Base Task Templates
          • Email Task Templates
          • Letter Task Templates
          • Note Task Templates
          • SMS Task Templates
          • VoiceSage Task Templates
          • Host-specific notes
        • Export & Import
        • Communications Queues
      • Host Operations
        • ActiveH Operations
          • Introduction
          • Actions
          • Databoxes & UDEs
          • Emails
          • Mail Merge Letters
          • Populating CallType
          • Populating JobType
          • Repairs Inspection Task
          • Repairs Interface
        • Fast Lean Smart
      • Best Practices
        • Extracting XML from Keyfax tables
        • Script Performance
        • Handling multiple rows from SQL
        • HTML Editor
        • Writing SQL Queries
      • Known Issues
        • Startup Messages
        • Running but not Visible
        • Error 1001 During Install
        • Stopped Working
    • Keyfax Staff
      • System Requirements
      • Advisor Feedback
      • Priority and Quantity
    • Keyfax Self-Service
      • System Requirements
      • Browser Support
    • KeyNamics
      • Model Driven Apps
      • Power Pages Portals
      • Installation
        • System Requirements
        • Solution Import
        • Basic Setup
        • Known Issues
      • Embedding
        • Model Driven Apps
        • Power Pages Portals
      • Configuration
        • Settings
        • Mappings
          • Creating Mappings
          • Minimum Mapping Requirements
          • Mapping Entity Form Fields
          • Mapping Lookup fields
          • Mapping Examples
        • FetchXML
          • Creating FetchXML queries
        • Logging
        • Test
      • Advanced
        • Mode Translation Rules
        • Customising Launch Button
        • Extending Export Data
        • Mapping Dump Fields
        • Mapping JSON Results
        • Enabling Help Panes
        • Mobile Operation
        • Handling uploaded content
      • Technical
        • Topology
        • Copying Environments
        • Keyfax Startup Data
        • Keyfax Export Data
    • Keyfax Client
      • Installation
        • Getting Started
        • Launch Tester
        • Uninstall / reinstall
        • Known Issues
    • Keyfax Cloud
      • Uptime Guarantee
      • Business Continuity
  • General
    • General FAQs
      • General Questions
      • Installation Questions
      • Migration Questions
      • Security Questions
      • Test & Training Questions
    • Keyfax FAQs
      • Keyfax Administrator Tools
      • Keyfax Staff
      • Keyfax Self-Service
      • KeyNamics
      • Keyfax Client
      • Keyfax Cloud
    • Issues & Solutions
      • Emails not working
    • Release Notes
      • Keyfax
        • 4.4.7
        • 4.4.6
        • 4.4.5
        • 4.4.4
        • 4.4.3
        • 4.4.2
        • 4.4.1
        • 4.4.0
        • Previous Releases
      • Keyfax Client
        • 4.0.0.44
        • 4.0.0.43
        • 4.0.0.42
        • Previous Releases
      • KeyNamics
        • 3.0.0.0
        • 2.0.0.13
        • Previous Releases
      • Older Releases
        • Staff
  • Integrations
    • API Docs
      • REST API
        • Quick Start
        • Deep Dive
        • API SDKs
          • .NET SDK
          • JavaScript SDK
          • Start-Up Data
          • Processing Results
        • API Reference
      • SOAP API
        • Quick Start
        • Error Handling
        • Status Codes
        • XML Schemas
          • Startup Schema
          • Results Schema
          • Results with Note
          • Cancelled Schema
          • Address data
      • Legacy APIs
        • Active X
        • Asynchronous Pluggable Protocols
        • XmlHttp
    • Integrations
      • Aareon
        • Introduction
        • Launching Keyfax Repairs
        • Launching Keyfax Enquiries
        • Configuration
        • SOAP based integration
        • QL Message fields
        • Known problems
      • Accuserve
      • ActiveH Desktop
        • Introduction
        • ActiveH Repair Interface
        • Known Problems
        • Keyfax Configuration
          • MISExchange.xml
          • Example Settings
          • Retrieving Block Codes
        • MIS Configuration
          • Exchange Process
          • Exchange Elements
          • User Permissions
          • User Security
          • UDE Interface
          • UDE Configuration
          • Settings
          • Desktop Configuration
          • Priorities Configuration
          • Populating Job Type
          • Populating Assigned To
          • Populating Call Classification
          • Configuring Log Call
            • Launching Keyfax from Response Repairs
          • Workflow Integration Actions
        • MIS interface Objects
          • CRM Gateway
          • Desktop Task
          • System Task Email Addressee
          • Desktop Task Action
          • Repair Request
          • Repair Request Inspection
          • Repair Request Task
      • ActiveH Portal (TIPS)
        • Introduction
        • Settings
        • Known Issues
      • ActiveH Web
      • Breeze IT
      • Caltech
      • Capita
        • Capita Housing / Academy
          • Host Table Usage
          • Troubleshooting
        • Open Housing
      • Civica
        • Civica CX
          • Introduction
          • Mappings
          • Start Up Data
          • Inspections
          • Known Issues
        • Civica CM
          • Known problems
        • Servitor
          • Example Import XML
          • Example Export XML
      • ContactView
      • Dynamics
      • Kirona
      • Lagan
      • MIS
      • MRI
      • Northgate
        • Launching Keyfax
        • Exchange process
        • XML/Field mappings
      • OneServe
      • ROCC
      • Total Mobile
        • Launching Keyfax (TASK)
        • TotalView Configuration
      • SDM
    • Best Practices
      • Integration Considerations
      • Displaying Keyfax Self-Service
  • Technical
    • General
      • Keyfax Architecture
      • Clearing Cache
    • Cloud Operation
      • Microsoft Azure
      • Amazon Web Services
    • Configuration Settings
      • Introduction
      • Paths Element
    • Developer Zone
      • eForm Technical Details
    • SQL Server
      • Freeing Space
      • Maintaining Indexes
      • Maintenance Plan
      • Restoring Live into Test
  • Links
    • Our Web Site
    • Our Blog
    • Try Keyfax
    • Contact Us
Powered by GitBook
On this page
  1. Product Suite
  2. Keyfax Administrator Tools
  3. Users

Keyfax SSO – via Microsoft Entra ID Support

Keyfax Single Sign On (SSO) allows password and permissions management to be orchestrated from Microsoft Entra Id allowing users to start Keyfax without entering a username or password.

PreviousFinding active usersNextAdvanced

Last updated 3 days ago

Microsoft Entra ID is a cloud-based service that manages identity and access to applications and services. With Keyfax 4.4.7.0 organizations can now leverage Microsoft Entra ID to centrally manage access and permissions throughout Keyfax.

Currently Microsoft Entra ID can be used to centrally manage access and permissions for Keyfax script authors who require access to Keyfax Administrator Tools. This gives organisations central control over access to the administrative interface of Keyfax and provides script authors a seamless single sign-on experience. For example, with Microsoft Entra ID support enabled, script authors no longer need to enter a username and password to access Keyfax Administrator Tools as shown below...

There are several possible configuration options for Keyfax SSO with Microsoft Entra ID:

  1. Authentication Only: Authentication (i.e. ability to sign into the 'Keyfax Administration Tool' or 'Keyfax Web Staff') using Microsoft Entra ID user 'memberships' of roles or applications; whilst user permissions remain under the control of the User Maintenance page in the 'Keyfax Administration Tool'

  2. Authentication And Permissions: Authentication and 'Keyfax Administration Tool' user permissions managed wholly by Microsoft Entra ID user 'memberships' of roles within the Microsoft Entra ID portal

  3. Application to Keyfax solution elements: Either of the above for the 'Keyfax Administration Tool' only or 'Keyfax Web Staff' solution only or both.

What are the benefits of using Keyfax SSO via Microsoft Entra ID support:

  1. Improved Security: By reducing password fatigue, users are less likely to reuse weak passwords. IT can enforce strong authentication methods like multi-factor authentication (MFA) alongside SSO, minimizing security risks.

  2. Better Compliance and Auditing: SSO solutions offer centralized logging and monitoring, which improves visibility into access activities, supports regulatory compliance, and simplifies auditing.

  3. Simplified User Management: IT teams can centrally manage authentication, making onboarding and offboarding more efficient. With SSO, revoking a user’s access across multiple platforms is easier and ensures compliance with security policies.

Use of Keyfax SSO for the 'Keyfax Web Staff' solution with a host system that is not yet using Microsoft Entra ID single sign on is not advised as the usernames for both the host system and Microsoft Entra ID must match for successful data transfer between Keyfax and the host.

However, as the usernames are the primary email address of the windows user in Microsoft Entra ID, if the host usernames can also be ensured to be the email address of the Staff, user data transition should be possible.

In addition, for call centre advisors and / or service staff Microsoft Entra ID can also be enabled to secure access and permissions for publicly facing installations of Keyfax Repair Diagnostics and / or Keyfax Enquiries Diagnostics. This is useful if you have a staff installation of Keyfax that needs to be accessed over the public internet but needs to be secure and only accessible to call centre advisors and / or service staff.

An example of editing a Microsoft Entra ID account via Keyfax Administrator Tools is shown below...

To control permissions and access to Keyfax for users and groups, application roles can be created within the Entra ID admin centre and mapped to the permissions seen above. In this configuration example, modification of permissions by the 'Keyfax Administration Tool' is disabled making permissions changes the jurisdiction of the IT department with control of Microsoft Entra ID.

Equally, an alternative configuration allows for the Keyfax permissions to be managed by the Keyfax Administrator (through the above page in the 'Keyfax Administration Tool') - in which case only the usernames and passwords are managed by Microsoft Entra ID.

Contact Omfax Support for more information.

Keyfax SSO allows Administration Tool access without requiring a username or password
Keyfax 4.4.7 Entra ID account