String Input Token Controller Element
Description
Renders an HTML input tag for a string property.
May be used by
Properties
Label (
label) Description
Label for the field. The UI treats it as a key to translate. If there is no translation, the label is shown in the UI as is.
Attributes
String
Mandatory
Example
userdata.label.email
Example
user.securid.username
Property (
property) Description
The property to use as value for this field.
The referenced property must be available in the attributes value of the generic token REST call response. If the property is nested, e.g. inside the contextData key, it can be referenced with dot notation (see example values).
The ID of the response is referenced by using the reserved value @id.
Attributes
String
Mandatory
Example
serialNumber
Example
contextData.email
Example
@id
Placeholder (
placeholder) Description
Displays a placeholder when the field has no value. The placeholder is not interpreted as value and disappears when typing in the field.
Attributes
String
Optional
Required (
required) Description
Whether this field must have a value when the token is added or updated. Required fields are marked with an asterisk.
Attributes
Boolean
Optional
Default value
false
Read-only (
readOnly) Description
If enabled, the field is read-only and cannot be altered by administrators via the UI.
Attributes
Boolean
Optional
Default value
false
Hide If Empty (
hideIfEmpty) Description
If enabled, this UI element is hidden if it has no value.
Attributes
Boolean
Optional
Default value
false
Validation (
validation) Description
Validates the input against the defined expression. If validation fails, an error on this field is shown to the administrator and the token cannot be added or updated.
Attributes
RegEx
Optional
YAML Template (with default values)
type: StringInputTokenControllerUiElement
id: StringInputTokenControllerUiElement-xxxxxx
displayName:
comment:
properties:
hideIfEmpty: false
label:
placeholder:
property:
readOnly: false
required: false
validation: