sym.sdk.forms.SymPromptForm

class sym.sdk.forms.SymPromptForm(*, fields: OrderedDict[str, sym.sdk.forms.PromptField], flow_vars: Dict[str, str] = {}, additional_header_text: Optional[str] = None)

Bases: pydantic.main.BaseModel

The current state of a form used to submit an access request to Sym.

field additional_header_text: Optional[str] = None

Additional text appended to the header text displayed at the top of the Slack request modal, after the default header text. Supports Slack markdown.

field fields: OrderedDict[str, sym.sdk.forms.PromptField] [Required]

A dictionary of PromptField objects, keyed by field name and in the order they would be displayed in the UI.

NOTE: While the PromptField objects may be modified to change the form’s state, the dictionary itself should not be modified.

field flow_vars: Dict[str, str] = {}

A dictionary of Flow vars and their string values, as defined in the sym_flow Terraform resource’s vars attribute.