Mandatory fields
The Hideez connector allows you to connect Hideez with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Hideez's wireless security key for passwordless user authentication and centralized password management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
Supported objects and operations
AccessProfile
Table 218: Supported operations for AccessProfile
| Create AccessProfile |
POST |
| Update AccessProfile |
PUT |
| Delete AccessProfile |
DELETE |
| Get AccessProfile |
GET |
| Get All AccessProfiles |
GET |
Companies
Table 219: Supported operations for Companies
| Create Company |
POST |
| Update Company |
PUT |
| Delete Company |
DELETE |
| Get Company |
GET |
| Get All Companies |
GET |
Departments
Table 220: Supported operations for Departments
| Create Department |
POST |
| Update Department |
PUT |
| Delete Department |
DELETE |
| Get Department |
GET |
| Get All Departments |
GET |
Devices
Table 221: Supported operations for Devices
| Update Devices |
PUT |
| Get Devices |
GET |
| Get All Devices |
GET |
Positions
Table 222: Supported operations for Positions
| Create Positions |
POST |
| Update Positions |
PUT |
| Delete Positions |
DELETE |
| Get Positions |
GET |
| Get All Positions |
GET |
Workstations
Table 223: Supported operations for Workstations
| Update Workstation |
PUT |
| Get Workstation |
GET |
| Get All Workstations |
GET |
Employees
Table 224: Supported operations for Employees
| Create Employee |
POST |
| Update Employee |
PUT |
| Delete Employee |
DELETE |
| Get Employee |
GET |
| Get All Employees |
GET |
This section lists the mandatory fields required to create a resource type.
AccessProfiles
Table 225: Mandatory feilds for AccessProfiles
| Name |
Yes |
Yes |
| PinLength |
Yes |
Yes |
| PinTryCount |
Yes |
Yes |
| PinExpiration |
Yes |
Yes |
| buttonBonding |
No |
Yes |
| buttonConnection |
No |
Yes |
| buttonNewChannel |
No |
Yes |
| pinNewChannel |
No |
Yes |
| masterKeyConnection |
No |
Yes |
| masterKeyNewChannel |
No |
Yes |
Companies
Departments
Devices (Update)
Positions
Workstations (Update)
Employees
- FirstName
- LastName
- Email
- DepartmentId
- PositionId
Mappings
The mappings are listed in the tables below.
Table 226: Employee mapping
| Id |
id |
| UserName |
UserName |
| firstName |
firstName |
| lastName |
lastName |
| email |
email |
| phoneNumber |
phoneNumber |
| departmentId |
departmentId |
| positionId |
positionId |
| device.id |
device.id |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.batterydevice.battery |
device.batterydevice.battery |
| device.firmware |
deviceirmware |
| device.state |
device.state |
| device.lastSynced |
device.lastSynced |
| device.employeeId |
device.employeeId |
| device.primaryAccountId |
device.primaryAccountId |
| device.acceessProfileId |
device.acceessProfileId |
| device.masterPassword |
device.masterPassword |
| device.importedAt |
device.importedAt |
| device.isOnline |
device.isOnline |
| device.deviceAccessProfile.Id |
device.deviceAccessProfile.Id |
| device.deviceAccessProfile. name |
device.deviceAccessProfile. name |
| device.deviceAccessProfile.createdAt |
device.deviceAccessProfile. createdAt |
| device.deviceAccessProfile. updatedAt |
device.deviceAccessProfile. updatedAt |
| device.deviceAccessProfile. buttonBonding |
device.deviceAccessProfile. buttonBonding |
| device.deviceAccessProfile. buttonConnection |
device.deviceAccessProfile. buttonConnection |
| device.deviceAccessProfile. buttonNewChannel |
device.deviceAccessProfile. buttonNewChannel |
| device.deviceAccessProfile. pinBonding |
device.deviceAccessProfile. pinBonding |
|
device.deviceAccessProfile.pinConnection |
device.deviceAccessProfile.buttonConnection |
|
device.deviceAccessProfile.pinNewChannel |
device.deviceAccessProfile.buttonNewChannel |
|
device.deviceAccessProfile.masterKeyBonding |
device.deviceAccessProfile.pinBonding |
|
device.deviceAccessProfile.masterKeyConnection |
device.deviceAccessProfile.pinConnection |
|
device.deviceAccessProfile.masterKeyNewChannel |
device.deviceAccessProfile.pinNewChannel |
|
device.deviceAccessProfile.pinExpiration |
device.deviceAccessProfile.pinExpiration |
|
device.deviceAccessProfile.pinLength |
device.deviceAccessProfile.pinLength |
|
device.deviceAccessProfile.pinTryCount |
device.deviceAccessProfile.pinTryCount |
|
device.deviceAccessProfile.pinExpirationConverted |
device.deviceAccessProfile.pinExpirationConverted |
|
device.deviceAccessProfile.pinExpirationString |
device.deviceAccessProfile.pinExpirationString |
|
department.Id |
department.Id |
|
department.companyId |
department.companyId |
|
department.name |
department.name |
|
department.company.id |
department.company.id |
|
department.company.name |
department.company.name |
|
position.id |
position.id |
|
position.name |
position.name |
|
fullName |
fullName |
|
empCompany |
empCompany |
|
empDepartment |
empDepartment |
|
currentDevice |
currentDevice |
Table 227: AccessProfile mapping
| Id |
Id |
| name |
name |
| createdAt |
createdAt |
| updatedAt |
updatedAt |
| buttonBonding |
buttonBonding |
| buttonConnection |
buttonConnection |
| buttonNewChannel |
buttonNewChannel |
|
pinBonding |
pinBonding |
|
pinConnection |
pinConnection |
|
pinNewChannel |
pinNewChannel |
|
masterKeyBonding |
masterKeyBonding |
|
masterKeyConnection |
masterKeyConnection |
|
masterKeyNewChannel |
masterKeyNewChannel |
|
pinExpiration |
pinExpiration |
|
pinLength |
pinLength |
|
pinTryCount |
pinTryCount |
|
pinExpirationConverted |
pinExpirationConverted |
|
pinExpirationString |
pinExpirationString |
|
device.id |
device.id |
|
device.mac |
device.mac |
|
device.model |
device.model |
|
device.rfid |
device.rfid |
|
device.battery |
device.battery |
|
device.firmware |
device.firmware |
|
device.battery |
device.battery |
|
device.state |
device.state |
|
device.lastSynced |
device.lastSynced |
|
device.employeeId |
device.employeeId |
|
device.primaryAccountId |
device.primaryAccountId |
|
device.acceessProfileId |
device.acceessProfileId |
|
device.masterPassword |
device.masterPassword |
|
device.importedAt |
device.importedAt |
|
device.isOnline |
device.isOnline |
Table 228: Company mapping
| id |
id |
| name |
name |
Table 229: Department mapping
| Id |
Id |
| companyId |
companyId |
| name |
name |
| company.id |
company.id |
| company.name |
company.name |
Table 230: Device mapping
| Id |
Id |
| mac |
mac |
| model |
model |
| rfid |
rfid |
| battery |
battery |
| firmware |
firmware |
| state |
state |
|
lastSynced |
lastSynced |
|
employeeId |
employeeId |
|
primaryAccountId |
primaryAccountId |
|
acceessProfileId |
acceessProfileId |
|
masterPassword |
masterPassword |
|
importedAt |
importedAt |
|
isOnline |
isOnline |
|
deviceAccessProfile.Id |
deviceAccessProfile.Id |
|
deviceAccessProfile.name |
deviceAccessProfile.name |
|
deviceAccessProfile.createdAt |
deviceAccessProfile.createdAt |
|
deviceAccessProfile.updatedAt |
deviceAccessProfile.updatedAt |
|
deviceAccessProfile.buttonBonding |
deviceAccessProfile.buttonBonding |
|
deviceAccessProfile.buttonConnection |
deviceAccessProfile.buttonConnection |
|
deviceAccessProfile.buttonNewChannel |
deviceAccessProfile.buttonNewChannel |
|
deviceAccessProfile.pinBonding |
deviceAccessProfile.pinBonding |
|
deviceAccessProfile.pinConnection |
deviceAccessProfile.pinConnection |
|
deviceAccessProfile.pinNewChannel |
deviceAccessProfile.pinNewChannel |
|
deviceAccessProfile.masterKeyBonding |
deviceAccessProfile.masterKeyBonding |
|
deviceAccessProfile.masterKeyConnection |
deviceAccessProfile.masterKeyConnection |
|
deviceAccessProfile.masterKeyNewChannel |
deviceAccessProfile.masterKeyNewChannel |
|
deviceAccessProfile.pinExpiration |
deviceAccessProfile.pinExpiration |
|
deviceAccessProfile.pinLength |
deviceAccessProfile.pinLength |
|
deviceAccessProfile.pinTryCount |
deviceAccessProfile.pinTryCount |
|
deviceAccessProfile.pinExpirationConverted |
deviceAccessProfile.pinExpirationConverted |
|
deviceAccessProfile.pinExpirationString |
deviceAccessProfile.pinExpirationString |
Table 231: Position mapping
| id |
id |
| name |
name |
Table 232: Workstation mapping
| Id |
Id |
| name |
name |
| domain |
domain |
| clientVersion |
clientVersion |
| departmentId |
departmentId |
| departmentName |
departmentName |
| os |
os |
|
ip |
ip |
|
lastSeen |
lastSeen |
|
approved |
approved |
|
rfid |
rfid |
|
companyId |
companyId |
|
companyName |
department.company.name |
|
proximityDevices[].Id |
proximityDevices[].Id |
|
proximityDevices[].deviceId |
proximityDevices[].deviceId |
|
proximityDevices[].workstationId |
proximityDevices[].workstationId |
|
proximityDevices[].lockProximity |
proximityDevices[].lockProximity |
|
proximityDevices[].unlockProximity |
proximityDevices[].unlockProximity |
|
proximityDevices[].lockTimeout |
proximityDevices[].lockTimeout |
Connector limitations
- You cannot edit an unapproved workstation. You can only edit approved workstations.
-
When you use http in the target URL for the POST, DELETE and Login operations, the cloud APIs return an error. Hence, it is recommended that you use https for the target URL parameter for all operations.
One Identity Manager E2E integration needs
For more information, see One Identity Manager E2E integration needs for Hideez connector.
Mappings
The Hideez connector allows you to connect Hideez with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Hideez's wireless security key for passwordless user authentication and centralized password management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
Supported objects and operations
AccessProfile
Table 218: Supported operations for AccessProfile
| Create AccessProfile |
POST |
| Update AccessProfile |
PUT |
| Delete AccessProfile |
DELETE |
| Get AccessProfile |
GET |
| Get All AccessProfiles |
GET |
Companies
Table 219: Supported operations for Companies
| Create Company |
POST |
| Update Company |
PUT |
| Delete Company |
DELETE |
| Get Company |
GET |
| Get All Companies |
GET |
Departments
Table 220: Supported operations for Departments
| Create Department |
POST |
| Update Department |
PUT |
| Delete Department |
DELETE |
| Get Department |
GET |
| Get All Departments |
GET |
Devices
Table 221: Supported operations for Devices
| Update Devices |
PUT |
| Get Devices |
GET |
| Get All Devices |
GET |
Positions
Table 222: Supported operations for Positions
| Create Positions |
POST |
| Update Positions |
PUT |
| Delete Positions |
DELETE |
| Get Positions |
GET |
| Get All Positions |
GET |
Workstations
Table 223: Supported operations for Workstations
| Update Workstation |
PUT |
| Get Workstation |
GET |
| Get All Workstations |
GET |
Employees
Table 224: Supported operations for Employees
| Create Employee |
POST |
| Update Employee |
PUT |
| Delete Employee |
DELETE |
| Get Employee |
GET |
| Get All Employees |
GET |
Mandatory fields
This section lists the mandatory fields required to create a resource type.
AccessProfiles
Table 225: Mandatory feilds for AccessProfiles
| Name |
Yes |
Yes |
| PinLength |
Yes |
Yes |
| PinTryCount |
Yes |
Yes |
| PinExpiration |
Yes |
Yes |
| buttonBonding |
No |
Yes |
| buttonConnection |
No |
Yes |
| buttonNewChannel |
No |
Yes |
| pinNewChannel |
No |
Yes |
| masterKeyConnection |
No |
Yes |
| masterKeyNewChannel |
No |
Yes |
Companies
Departments
Devices (Update)
Positions
Workstations (Update)
Employees
- FirstName
- LastName
- Email
- DepartmentId
- PositionId
The mappings are listed in the tables below.
Table 226: Employee mapping
| Id |
id |
| UserName |
UserName |
| firstName |
firstName |
| lastName |
lastName |
| email |
email |
| phoneNumber |
phoneNumber |
| departmentId |
departmentId |
| positionId |
positionId |
| device.id |
device.id |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.batterydevice.battery |
device.batterydevice.battery |
| device.firmware |
deviceirmware |
| device.state |
device.state |
| device.lastSynced |
device.lastSynced |
| device.employeeId |
device.employeeId |
| device.primaryAccountId |
device.primaryAccountId |
| device.acceessProfileId |
device.acceessProfileId |
| device.masterPassword |
device.masterPassword |
| device.importedAt |
device.importedAt |
| device.isOnline |
device.isOnline |
| device.deviceAccessProfile.Id |
device.deviceAccessProfile.Id |
| device.deviceAccessProfile. name |
device.deviceAccessProfile. name |
| device.deviceAccessProfile.createdAt |
device.deviceAccessProfile. createdAt |
| device.deviceAccessProfile. updatedAt |
device.deviceAccessProfile. updatedAt |
| device.deviceAccessProfile. buttonBonding |
device.deviceAccessProfile. buttonBonding |
| device.deviceAccessProfile. buttonConnection |
device.deviceAccessProfile. buttonConnection |
| device.deviceAccessProfile. buttonNewChannel |
device.deviceAccessProfile. buttonNewChannel |
| device.deviceAccessProfile. pinBonding |
device.deviceAccessProfile. pinBonding |
|
device.deviceAccessProfile.pinConnection |
device.deviceAccessProfile.buttonConnection |
|
device.deviceAccessProfile.pinNewChannel |
device.deviceAccessProfile.buttonNewChannel |
|
device.deviceAccessProfile.masterKeyBonding |
device.deviceAccessProfile.pinBonding |
|
device.deviceAccessProfile.masterKeyConnection |
device.deviceAccessProfile.pinConnection |
|
device.deviceAccessProfile.masterKeyNewChannel |
device.deviceAccessProfile.pinNewChannel |
|
device.deviceAccessProfile.pinExpiration |
device.deviceAccessProfile.pinExpiration |
|
device.deviceAccessProfile.pinLength |
device.deviceAccessProfile.pinLength |
|
device.deviceAccessProfile.pinTryCount |
device.deviceAccessProfile.pinTryCount |
|
device.deviceAccessProfile.pinExpirationConverted |
device.deviceAccessProfile.pinExpirationConverted |
|
device.deviceAccessProfile.pinExpirationString |
device.deviceAccessProfile.pinExpirationString |
|
department.Id |
department.Id |
|
department.companyId |
department.companyId |
|
department.name |
department.name |
|
department.company.id |
department.company.id |
|
department.company.name |
department.company.name |
|
position.id |
position.id |
|
position.name |
position.name |
|
fullName |
fullName |
|
empCompany |
empCompany |
|
empDepartment |
empDepartment |
|
currentDevice |
currentDevice |
Table 227: AccessProfile mapping
| Id |
Id |
| name |
name |
| createdAt |
createdAt |
| updatedAt |
updatedAt |
| buttonBonding |
buttonBonding |
| buttonConnection |
buttonConnection |
| buttonNewChannel |
buttonNewChannel |
|
pinBonding |
pinBonding |
|
pinConnection |
pinConnection |
|
pinNewChannel |
pinNewChannel |
|
masterKeyBonding |
masterKeyBonding |
|
masterKeyConnection |
masterKeyConnection |
|
masterKeyNewChannel |
masterKeyNewChannel |
|
pinExpiration |
pinExpiration |
|
pinLength |
pinLength |
|
pinTryCount |
pinTryCount |
|
pinExpirationConverted |
pinExpirationConverted |
|
pinExpirationString |
pinExpirationString |
|
device.id |
device.id |
|
device.mac |
device.mac |
|
device.model |
device.model |
|
device.rfid |
device.rfid |
|
device.battery |
device.battery |
|
device.firmware |
device.firmware |
|
device.battery |
device.battery |
|
device.state |
device.state |
|
device.lastSynced |
device.lastSynced |
|
device.employeeId |
device.employeeId |
|
device.primaryAccountId |
device.primaryAccountId |
|
device.acceessProfileId |
device.acceessProfileId |
|
device.masterPassword |
device.masterPassword |
|
device.importedAt |
device.importedAt |
|
device.isOnline |
device.isOnline |
Table 228: Company mapping
| id |
id |
| name |
name |
Table 229: Department mapping
| Id |
Id |
| companyId |
companyId |
| name |
name |
| company.id |
company.id |
| company.name |
company.name |
Table 230: Device mapping
| Id |
Id |
| mac |
mac |
| model |
model |
| rfid |
rfid |
| battery |
battery |
| firmware |
firmware |
| state |
state |
|
lastSynced |
lastSynced |
|
employeeId |
employeeId |
|
primaryAccountId |
primaryAccountId |
|
acceessProfileId |
acceessProfileId |
|
masterPassword |
masterPassword |
|
importedAt |
importedAt |
|
isOnline |
isOnline |
|
deviceAccessProfile.Id |
deviceAccessProfile.Id |
|
deviceAccessProfile.name |
deviceAccessProfile.name |
|
deviceAccessProfile.createdAt |
deviceAccessProfile.createdAt |
|
deviceAccessProfile.updatedAt |
deviceAccessProfile.updatedAt |
|
deviceAccessProfile.buttonBonding |
deviceAccessProfile.buttonBonding |
|
deviceAccessProfile.buttonConnection |
deviceAccessProfile.buttonConnection |
|
deviceAccessProfile.buttonNewChannel |
deviceAccessProfile.buttonNewChannel |
|
deviceAccessProfile.pinBonding |
deviceAccessProfile.pinBonding |
|
deviceAccessProfile.pinConnection |
deviceAccessProfile.pinConnection |
|
deviceAccessProfile.pinNewChannel |
deviceAccessProfile.pinNewChannel |
|
deviceAccessProfile.masterKeyBonding |
deviceAccessProfile.masterKeyBonding |
|
deviceAccessProfile.masterKeyConnection |
deviceAccessProfile.masterKeyConnection |
|
deviceAccessProfile.masterKeyNewChannel |
deviceAccessProfile.masterKeyNewChannel |
|
deviceAccessProfile.pinExpiration |
deviceAccessProfile.pinExpiration |
|
deviceAccessProfile.pinLength |
deviceAccessProfile.pinLength |
|
deviceAccessProfile.pinTryCount |
deviceAccessProfile.pinTryCount |
|
deviceAccessProfile.pinExpirationConverted |
deviceAccessProfile.pinExpirationConverted |
|
deviceAccessProfile.pinExpirationString |
deviceAccessProfile.pinExpirationString |
Table 231: Position mapping
| id |
id |
| name |
name |
Table 232: Workstation mapping
| Id |
Id |
| name |
name |
| domain |
domain |
| clientVersion |
clientVersion |
| departmentId |
departmentId |
| departmentName |
departmentName |
| os |
os |
|
ip |
ip |
|
lastSeen |
lastSeen |
|
approved |
approved |
|
rfid |
rfid |
|
companyId |
companyId |
|
companyName |
department.company.name |
|
proximityDevices[].Id |
proximityDevices[].Id |
|
proximityDevices[].deviceId |
proximityDevices[].deviceId |
|
proximityDevices[].workstationId |
proximityDevices[].workstationId |
|
proximityDevices[].lockProximity |
proximityDevices[].lockProximity |
|
proximityDevices[].unlockProximity |
proximityDevices[].unlockProximity |
|
proximityDevices[].lockTimeout |
proximityDevices[].lockTimeout |
Connector limitations
- You cannot edit an unapproved workstation. You can only edit approved workstations.
-
When you use http in the target URL for the POST, DELETE and Login operations, the cloud APIs return an error. Hence, it is recommended that you use https for the target URL parameter for all operations.
One Identity Manager E2E integration needs
For more information, see One Identity Manager E2E integration needs for Hideez connector.
Connector limitations
The Hideez connector allows you to connect Hideez with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Hideez's wireless security key for passwordless user authentication and centralized password management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
Supported objects and operations
AccessProfile
Table 218: Supported operations for AccessProfile
| Create AccessProfile |
POST |
| Update AccessProfile |
PUT |
| Delete AccessProfile |
DELETE |
| Get AccessProfile |
GET |
| Get All AccessProfiles |
GET |
Companies
Table 219: Supported operations for Companies
| Create Company |
POST |
| Update Company |
PUT |
| Delete Company |
DELETE |
| Get Company |
GET |
| Get All Companies |
GET |
Departments
Table 220: Supported operations for Departments
| Create Department |
POST |
| Update Department |
PUT |
| Delete Department |
DELETE |
| Get Department |
GET |
| Get All Departments |
GET |
Devices
Table 221: Supported operations for Devices
| Update Devices |
PUT |
| Get Devices |
GET |
| Get All Devices |
GET |
Positions
Table 222: Supported operations for Positions
| Create Positions |
POST |
| Update Positions |
PUT |
| Delete Positions |
DELETE |
| Get Positions |
GET |
| Get All Positions |
GET |
Workstations
Table 223: Supported operations for Workstations
| Update Workstation |
PUT |
| Get Workstation |
GET |
| Get All Workstations |
GET |
Employees
Table 224: Supported operations for Employees
| Create Employee |
POST |
| Update Employee |
PUT |
| Delete Employee |
DELETE |
| Get Employee |
GET |
| Get All Employees |
GET |
Mandatory fields
This section lists the mandatory fields required to create a resource type.
AccessProfiles
Table 225: Mandatory feilds for AccessProfiles
| Name |
Yes |
Yes |
| PinLength |
Yes |
Yes |
| PinTryCount |
Yes |
Yes |
| PinExpiration |
Yes |
Yes |
| buttonBonding |
No |
Yes |
| buttonConnection |
No |
Yes |
| buttonNewChannel |
No |
Yes |
| pinNewChannel |
No |
Yes |
| masterKeyConnection |
No |
Yes |
| masterKeyNewChannel |
No |
Yes |
Companies
Departments
Devices (Update)
Positions
Workstations (Update)
Employees
- FirstName
- LastName
- Email
- DepartmentId
- PositionId
Mappings
The mappings are listed in the tables below.
Table 226: Employee mapping
| Id |
id |
| UserName |
UserName |
| firstName |
firstName |
| lastName |
lastName |
| email |
email |
| phoneNumber |
phoneNumber |
| departmentId |
departmentId |
| positionId |
positionId |
| device.id |
device.id |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.batterydevice.battery |
device.batterydevice.battery |
| device.firmware |
deviceirmware |
| device.state |
device.state |
| device.lastSynced |
device.lastSynced |
| device.employeeId |
device.employeeId |
| device.primaryAccountId |
device.primaryAccountId |
| device.acceessProfileId |
device.acceessProfileId |
| device.masterPassword |
device.masterPassword |
| device.importedAt |
device.importedAt |
| device.isOnline |
device.isOnline |
| device.deviceAccessProfile.Id |
device.deviceAccessProfile.Id |
| device.deviceAccessProfile. name |
device.deviceAccessProfile. name |
| device.deviceAccessProfile.createdAt |
device.deviceAccessProfile. createdAt |
| device.deviceAccessProfile. updatedAt |
device.deviceAccessProfile. updatedAt |
| device.deviceAccessProfile. buttonBonding |
device.deviceAccessProfile. buttonBonding |
| device.deviceAccessProfile. buttonConnection |
device.deviceAccessProfile. buttonConnection |
| device.deviceAccessProfile. buttonNewChannel |
device.deviceAccessProfile. buttonNewChannel |
| device.deviceAccessProfile. pinBonding |
device.deviceAccessProfile. pinBonding |
|
device.deviceAccessProfile.pinConnection |
device.deviceAccessProfile.buttonConnection |
|
device.deviceAccessProfile.pinNewChannel |
device.deviceAccessProfile.buttonNewChannel |
|
device.deviceAccessProfile.masterKeyBonding |
device.deviceAccessProfile.pinBonding |
|
device.deviceAccessProfile.masterKeyConnection |
device.deviceAccessProfile.pinConnection |
|
device.deviceAccessProfile.masterKeyNewChannel |
device.deviceAccessProfile.pinNewChannel |
|
device.deviceAccessProfile.pinExpiration |
device.deviceAccessProfile.pinExpiration |
|
device.deviceAccessProfile.pinLength |
device.deviceAccessProfile.pinLength |
|
device.deviceAccessProfile.pinTryCount |
device.deviceAccessProfile.pinTryCount |
|
device.deviceAccessProfile.pinExpirationConverted |
device.deviceAccessProfile.pinExpirationConverted |
|
device.deviceAccessProfile.pinExpirationString |
device.deviceAccessProfile.pinExpirationString |
|
department.Id |
department.Id |
|
department.companyId |
department.companyId |
|
department.name |
department.name |
|
department.company.id |
department.company.id |
|
department.company.name |
department.company.name |
|
position.id |
position.id |
|
position.name |
position.name |
|
fullName |
fullName |
|
empCompany |
empCompany |
|
empDepartment |
empDepartment |
|
currentDevice |
currentDevice |
Table 227: AccessProfile mapping
| Id |
Id |
| name |
name |
| createdAt |
createdAt |
| updatedAt |
updatedAt |
| buttonBonding |
buttonBonding |
| buttonConnection |
buttonConnection |
| buttonNewChannel |
buttonNewChannel |
|
pinBonding |
pinBonding |
|
pinConnection |
pinConnection |
|
pinNewChannel |
pinNewChannel |
|
masterKeyBonding |
masterKeyBonding |
|
masterKeyConnection |
masterKeyConnection |
|
masterKeyNewChannel |
masterKeyNewChannel |
|
pinExpiration |
pinExpiration |
|
pinLength |
pinLength |
|
pinTryCount |
pinTryCount |
|
pinExpirationConverted |
pinExpirationConverted |
|
pinExpirationString |
pinExpirationString |
|
device.id |
device.id |
|
device.mac |
device.mac |
|
device.model |
device.model |
|
device.rfid |
device.rfid |
|
device.battery |
device.battery |
|
device.firmware |
device.firmware |
|
device.battery |
device.battery |
|
device.state |
device.state |
|
device.lastSynced |
device.lastSynced |
|
device.employeeId |
device.employeeId |
|
device.primaryAccountId |
device.primaryAccountId |
|
device.acceessProfileId |
device.acceessProfileId |
|
device.masterPassword |
device.masterPassword |
|
device.importedAt |
device.importedAt |
|
device.isOnline |
device.isOnline |
Table 228: Company mapping
| id |
id |
| name |
name |
Table 229: Department mapping
| Id |
Id |
| companyId |
companyId |
| name |
name |
| company.id |
company.id |
| company.name |
company.name |
Table 230: Device mapping
| Id |
Id |
| mac |
mac |
| model |
model |
| rfid |
rfid |
| battery |
battery |
| firmware |
firmware |
| state |
state |
|
lastSynced |
lastSynced |
|
employeeId |
employeeId |
|
primaryAccountId |
primaryAccountId |
|
acceessProfileId |
acceessProfileId |
|
masterPassword |
masterPassword |
|
importedAt |
importedAt |
|
isOnline |
isOnline |
|
deviceAccessProfile.Id |
deviceAccessProfile.Id |
|
deviceAccessProfile.name |
deviceAccessProfile.name |
|
deviceAccessProfile.createdAt |
deviceAccessProfile.createdAt |
|
deviceAccessProfile.updatedAt |
deviceAccessProfile.updatedAt |
|
deviceAccessProfile.buttonBonding |
deviceAccessProfile.buttonBonding |
|
deviceAccessProfile.buttonConnection |
deviceAccessProfile.buttonConnection |
|
deviceAccessProfile.buttonNewChannel |
deviceAccessProfile.buttonNewChannel |
|
deviceAccessProfile.pinBonding |
deviceAccessProfile.pinBonding |
|
deviceAccessProfile.pinConnection |
deviceAccessProfile.pinConnection |
|
deviceAccessProfile.pinNewChannel |
deviceAccessProfile.pinNewChannel |
|
deviceAccessProfile.masterKeyBonding |
deviceAccessProfile.masterKeyBonding |
|
deviceAccessProfile.masterKeyConnection |
deviceAccessProfile.masterKeyConnection |
|
deviceAccessProfile.masterKeyNewChannel |
deviceAccessProfile.masterKeyNewChannel |
|
deviceAccessProfile.pinExpiration |
deviceAccessProfile.pinExpiration |
|
deviceAccessProfile.pinLength |
deviceAccessProfile.pinLength |
|
deviceAccessProfile.pinTryCount |
deviceAccessProfile.pinTryCount |
|
deviceAccessProfile.pinExpirationConverted |
deviceAccessProfile.pinExpirationConverted |
|
deviceAccessProfile.pinExpirationString |
deviceAccessProfile.pinExpirationString |
Table 231: Position mapping
| id |
id |
| name |
name |
Table 232: Workstation mapping
| Id |
Id |
| name |
name |
| domain |
domain |
| clientVersion |
clientVersion |
| departmentId |
departmentId |
| departmentName |
departmentName |
| os |
os |
|
ip |
ip |
|
lastSeen |
lastSeen |
|
approved |
approved |
|
rfid |
rfid |
|
companyId |
companyId |
|
companyName |
department.company.name |
|
proximityDevices[].Id |
proximityDevices[].Id |
|
proximityDevices[].deviceId |
proximityDevices[].deviceId |
|
proximityDevices[].workstationId |
proximityDevices[].workstationId |
|
proximityDevices[].lockProximity |
proximityDevices[].lockProximity |
|
proximityDevices[].unlockProximity |
proximityDevices[].unlockProximity |
|
proximityDevices[].lockTimeout |
proximityDevices[].lockTimeout |
- You cannot edit an unapproved workstation. You can only edit approved workstations.
-
When you use http in the target URL for the POST, DELETE and Login operations, the cloud APIs return an error. Hence, it is recommended that you use https for the target URL parameter for all operations.
One Identity Manager E2E integration needs
For more information, see One Identity Manager E2E integration needs for Hideez connector.
One Identity Manager E2E integration needs
The Hideez connector allows you to connect Hideez with One Identity Starling enabling you to take advantage of the features and products available with Starling Connect that complement and enhance Hideez's wireless security key for passwordless user authentication and centralized password management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
Supported objects and operations
AccessProfile
Table 218: Supported operations for AccessProfile
| Create AccessProfile |
POST |
| Update AccessProfile |
PUT |
| Delete AccessProfile |
DELETE |
| Get AccessProfile |
GET |
| Get All AccessProfiles |
GET |
Companies
Table 219: Supported operations for Companies
| Create Company |
POST |
| Update Company |
PUT |
| Delete Company |
DELETE |
| Get Company |
GET |
| Get All Companies |
GET |
Departments
Table 220: Supported operations for Departments
| Create Department |
POST |
| Update Department |
PUT |
| Delete Department |
DELETE |
| Get Department |
GET |
| Get All Departments |
GET |
Devices
Table 221: Supported operations for Devices
| Update Devices |
PUT |
| Get Devices |
GET |
| Get All Devices |
GET |
Positions
Table 222: Supported operations for Positions
| Create Positions |
POST |
| Update Positions |
PUT |
| Delete Positions |
DELETE |
| Get Positions |
GET |
| Get All Positions |
GET |
Workstations
Table 223: Supported operations for Workstations
| Update Workstation |
PUT |
| Get Workstation |
GET |
| Get All Workstations |
GET |
Employees
Table 224: Supported operations for Employees
| Create Employee |
POST |
| Update Employee |
PUT |
| Delete Employee |
DELETE |
| Get Employee |
GET |
| Get All Employees |
GET |
Mandatory fields
This section lists the mandatory fields required to create a resource type.
AccessProfiles
Table 225: Mandatory feilds for AccessProfiles
| Name |
Yes |
Yes |
| PinLength |
Yes |
Yes |
| PinTryCount |
Yes |
Yes |
| PinExpiration |
Yes |
Yes |
| buttonBonding |
No |
Yes |
| buttonConnection |
No |
Yes |
| buttonNewChannel |
No |
Yes |
| pinNewChannel |
No |
Yes |
| masterKeyConnection |
No |
Yes |
| masterKeyNewChannel |
No |
Yes |
Companies
Departments
Devices (Update)
Positions
Workstations (Update)
Employees
- FirstName
- LastName
- Email
- DepartmentId
- PositionId
Mappings
The mappings are listed in the tables below.
Table 226: Employee mapping
| Id |
id |
| UserName |
UserName |
| firstName |
firstName |
| lastName |
lastName |
| email |
email |
| phoneNumber |
phoneNumber |
| departmentId |
departmentId |
| positionId |
positionId |
| device.id |
device.id |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.mac |
device.mac |
| device.model |
device.model |
| device.rfid |
device.rfid |
| device.batterydevice.battery |
device.batterydevice.battery |
| device.firmware |
deviceirmware |
| device.state |
device.state |
| device.lastSynced |
device.lastSynced |
| device.employeeId |
device.employeeId |
| device.primaryAccountId |
device.primaryAccountId |
| device.acceessProfileId |
device.acceessProfileId |
| device.masterPassword |
device.masterPassword |
| device.importedAt |
device.importedAt |
| device.isOnline |
device.isOnline |
| device.deviceAccessProfile.Id |
device.deviceAccessProfile.Id |
| device.deviceAccessProfile. name |
device.deviceAccessProfile. name |
| device.deviceAccessProfile.createdAt |
device.deviceAccessProfile. createdAt |
| device.deviceAccessProfile. updatedAt |
device.deviceAccessProfile. updatedAt |
| device.deviceAccessProfile. buttonBonding |
device.deviceAccessProfile. buttonBonding |
| device.deviceAccessProfile. buttonConnection |
device.deviceAccessProfile. buttonConnection |
| device.deviceAccessProfile. buttonNewChannel |
device.deviceAccessProfile. buttonNewChannel |
| device.deviceAccessProfile. pinBonding |
device.deviceAccessProfile. pinBonding |
|
device.deviceAccessProfile.pinConnection |
device.deviceAccessProfile.buttonConnection |
|
device.deviceAccessProfile.pinNewChannel |
device.deviceAccessProfile.buttonNewChannel |
|
device.deviceAccessProfile.masterKeyBonding |
device.deviceAccessProfile.pinBonding |
|
device.deviceAccessProfile.masterKeyConnection |
device.deviceAccessProfile.pinConnection |
|
device.deviceAccessProfile.masterKeyNewChannel |
device.deviceAccessProfile.pinNewChannel |
|
device.deviceAccessProfile.pinExpiration |
device.deviceAccessProfile.pinExpiration |
|
device.deviceAccessProfile.pinLength |
device.deviceAccessProfile.pinLength |
|
device.deviceAccessProfile.pinTryCount |
device.deviceAccessProfile.pinTryCount |
|
device.deviceAccessProfile.pinExpirationConverted |
device.deviceAccessProfile.pinExpirationConverted |
|
device.deviceAccessProfile.pinExpirationString |
device.deviceAccessProfile.pinExpirationString |
|
department.Id |
department.Id |
|
department.companyId |
department.companyId |
|
department.name |
department.name |
|
department.company.id |
department.company.id |
|
department.company.name |
department.company.name |
|
position.id |
position.id |
|
position.name |
position.name |
|
fullName |
fullName |
|
empCompany |
empCompany |
|
empDepartment |
empDepartment |
|
currentDevice |
currentDevice |
Table 227: AccessProfile mapping
| Id |
Id |
| name |
name |
| createdAt |
createdAt |
| updatedAt |
updatedAt |
| buttonBonding |
buttonBonding |
| buttonConnection |
buttonConnection |
| buttonNewChannel |
buttonNewChannel |
|
pinBonding |
pinBonding |
|
pinConnection |
pinConnection |
|
pinNewChannel |
pinNewChannel |
|
masterKeyBonding |
masterKeyBonding |
|
masterKeyConnection |
masterKeyConnection |
|
masterKeyNewChannel |
masterKeyNewChannel |
|
pinExpiration |
pinExpiration |
|
pinLength |
pinLength |
|
pinTryCount |
pinTryCount |
|
pinExpirationConverted |
pinExpirationConverted |
|
pinExpirationString |
pinExpirationString |
|
device.id |
device.id |
|
device.mac |
device.mac |
|
device.model |
device.model |
|
device.rfid |
device.rfid |
|
device.battery |
device.battery |
|
device.firmware |
device.firmware |
|
device.battery |
device.battery |
|
device.state |
device.state |
|
device.lastSynced |
device.lastSynced |
|
device.employeeId |
device.employeeId |
|
device.primaryAccountId |
device.primaryAccountId |
|
device.acceessProfileId |
device.acceessProfileId |
|
device.masterPassword |
device.masterPassword |
|
device.importedAt |
device.importedAt |
|
device.isOnline |
device.isOnline |
Table 228: Company mapping
| id |
id |
| name |
name |
Table 229: Department mapping
| Id |
Id |
| companyId |
companyId |
| name |
name |
| company.id |
company.id |
| company.name |
company.name |
Table 230: Device mapping
| Id |
Id |
| mac |
mac |
| model |
model |
| rfid |
rfid |
| battery |
battery |
| firmware |
firmware |
| state |
state |
|
lastSynced |
lastSynced |
|
employeeId |
employeeId |
|
primaryAccountId |
primaryAccountId |
|
acceessProfileId |
acceessProfileId |
|
masterPassword |
masterPassword |
|
importedAt |
importedAt |
|
isOnline |
isOnline |
|
deviceAccessProfile.Id |
deviceAccessProfile.Id |
|
deviceAccessProfile.name |
deviceAccessProfile.name |
|
deviceAccessProfile.createdAt |
deviceAccessProfile.createdAt |
|
deviceAccessProfile.updatedAt |
deviceAccessProfile.updatedAt |
|
deviceAccessProfile.buttonBonding |
deviceAccessProfile.buttonBonding |
|
deviceAccessProfile.buttonConnection |
deviceAccessProfile.buttonConnection |
|
deviceAccessProfile.buttonNewChannel |
deviceAccessProfile.buttonNewChannel |
|
deviceAccessProfile.pinBonding |
deviceAccessProfile.pinBonding |
|
deviceAccessProfile.pinConnection |
deviceAccessProfile.pinConnection |
|
deviceAccessProfile.pinNewChannel |
deviceAccessProfile.pinNewChannel |
|
deviceAccessProfile.masterKeyBonding |
deviceAccessProfile.masterKeyBonding |
|
deviceAccessProfile.masterKeyConnection |
deviceAccessProfile.masterKeyConnection |
|
deviceAccessProfile.masterKeyNewChannel |
deviceAccessProfile.masterKeyNewChannel |
|
deviceAccessProfile.pinExpiration |
deviceAccessProfile.pinExpiration |
|
deviceAccessProfile.pinLength |
deviceAccessProfile.pinLength |
|
deviceAccessProfile.pinTryCount |
deviceAccessProfile.pinTryCount |
|
deviceAccessProfile.pinExpirationConverted |
deviceAccessProfile.pinExpirationConverted |
|
deviceAccessProfile.pinExpirationString |
deviceAccessProfile.pinExpirationString |
Table 231: Position mapping
| id |
id |
| name |
name |
Table 232: Workstation mapping
| Id |
Id |
| name |
name |
| domain |
domain |
| clientVersion |
clientVersion |
| departmentId |
departmentId |
| departmentName |
departmentName |
| os |
os |
|
ip |
ip |
|
lastSeen |
lastSeen |
|
approved |
approved |
|
rfid |
rfid |
|
companyId |
companyId |
|
companyName |
department.company.name |
|
proximityDevices[].Id |
proximityDevices[].Id |
|
proximityDevices[].deviceId |
proximityDevices[].deviceId |
|
proximityDevices[].workstationId |
proximityDevices[].workstationId |
|
proximityDevices[].lockProximity |
proximityDevices[].lockProximity |
|
proximityDevices[].unlockProximity |
proximityDevices[].unlockProximity |
|
proximityDevices[].lockTimeout |
proximityDevices[].lockTimeout |
Connector limitations
- You cannot edit an unapproved workstation. You can only edit approved workstations.
-
When you use http in the target URL for the POST, DELETE and Login operations, the cloud APIs return an error. Hence, it is recommended that you use https for the target URL parameter for all operations.
For more information, see One Identity Manager E2E integration needs for Hideez connector.
