Single Field Selector
Specification
{
"fieldSelectorType": "Single",
"fieldName": "<string>"
}
Structure Values
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
fieldSelectorType | String | The type of field selector. | Required | |
fieldName | String | The name of the field to select. | Required |
Example
{
"fieldSelectorType": "Single",
"fieldName": "username"
}
List Field Selector
Specification
{
"fieldSelectorType": "List",
"fieldNames": [<list<string>>]
}
Structure Values
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
fieldSelectorType | String | The type of field selector. | Required | |
fieldNames | String | The names of the fields to select. | Required |
Example
{
"fieldSelectorType": "List",
"fieldNames": ["username", "user_email"]
}
Regex Field Selector
Specification
{
"fieldSelectorType": "Regex",
"pattern": "<string>"
}
Structure Values
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
fieldSelectorType | String | The type of field selector. | Required | |
fieldName | String | A regex pattern that matches the name of any field to be selected. Special characters must be escaped using backslashes when included in a JSON spec. | Required |
Example
{
"fieldSelectorType": "Regex",
"fieldName": "^user.+$"
}