Input Parameter (REST Authentication)
Collaborate with us
Edit this page on GitHub
Input parameter of the exposed REST API authentication action (Username or Password). Both Username and Password input parameters are added/removed automatically by Service Studio when configuring the REST API to use Basic authentication/Custom authentication, respectively.
Properties
| Name | Description | Mandatory | Default value | Observations |
|---|---|---|---|---|
| Name | Identifies an element in the scope where it is defined, like a screen, action, or module. | Yes | ||
| Description | Text that documents the element. | Useful for documentation purpose. The maximum size of this property is 2000 characters. |
||
| Data Type | The data type of the input parameter. | Yes | ||
| Is Mandatory | Set to Yes to require for a value to be set. | Yes | Yes | |
| Advanced | ||||
| Default Value | Initial value of this element. If undefined, the default value of the data type is used. | |||