PersonGroup interface

Person group object.

Extends

Properties

name

User defined name, maximum length is 128.

personGroupId

PersonGroupId of the target person group.

recognitionModel

Possible values include: 'recognition_01', 'recognition_02', 'recognition_03', 'recognition_04'. Default value: 'recognition_01'.

userData

User specified data. Length should not exceed 16KB.

Property Details

name

User defined name, maximum length is 128.

name?: undefined | string

Property Value

undefined | string

personGroupId

PersonGroupId of the target person group.

personGroupId: string

Property Value

string

recognitionModel

Possible values include: 'recognition_01', 'recognition_02', 'recognition_03', 'recognition_04'. Default value: 'recognition_01'.

recognitionModel?: RecognitionModel

Property Value

userData

User specified data. Length should not exceed 16KB.

userData?: undefined | string

Property Value

undefined | string