Forms
The form allows you to add user-specific LoginRadius profile fields that can be utilized in Auth Studio and APIs. Once created and added here, these fields can enhance user registration and management workflows. These forms serve as a bridge to capture essential user information in a structured and efficient manner, making them integral to authentication and user management.
The form fields are categorized into three types:
- Standard Fields (Basic)
- Standard Fields (Advanced)
- Custom Fields
Each field is fully customizable. You can:
- Modify the field name.
- Set the field type.
- Mark the field as mandatory or optional.
- Add validation strings to enforce specific input formats. Customizations ensure the flexibility needed to align with your business requirements.
Common Use-cases
LoginRadius provides a flexible data schema that allows businesses to customize their user registration forms based on their unique needs.
- Customizable Registration Forms: Design forms tailored to capture user-specific details aligned with your business needs, ensuring better data collection and organization.
- Enhanced User Management: Utilize these forms to integrate user profile fields with Auth Studio and APIs, simplifying the management and retrieval of user data.
- Validation and Flexibility: To ensure data integrity, apply validation strings and customizable field settings (e.g., mandatory or optional) for accurate and structured data.
Key Features
The following fields are available for use in registration forms:
Standard Fields (Basic)
Standard Fields are the most commonly used fields for registration forms. There are around 30+ predefined Basic Standard Fields, for e.g:
- About
- City
- Country
- Date of Birth
- Email Subscription
- First Name
- Gender
- Home Town
- Image URL
- Industry
- Last Name
- Local City
- Local Country
- Main Address
- Middle Name
- Nick Name
- Phone ID
- Political
- Prefix
- Profile Country
- Relationship Status
- Religion
- State
- Suffix
- Thumbnail Image URL
- Time Zone
- Username
Standard Fields (Advanced)
The Advanced Standard Fields include more complex predefined fields that can be enabled with a simple click.
- Address
- Education
- IM Accounts
- Interest
- Phone Numbers
- Positions
- Sports
For more information about the Supported field and its details, please refer to the Detailed Data Point Document[/user-management/user-data/normalized-user-profile/detailed-data-points]
Custom Fields
Custom Fields allow the creation of unique fields beyond the predefined standard field lists. They enable businesses to capture data points specific to their operations or industry that the default options may not cover. These fields are fully customizable, allowing you to define attributes such as name, type, validation rules, and whether the field is mandatory or optional. This ensures that your registration forms align perfectly with your business requirements and data collection goals.
Use-case for Custom Fields:
- Business-Specific Data Collection: Capture unique data points, such as loyalty program IDs, customer preferences, or industry-specific information not included in standard fields.
- Personalized User Experiences: Leverage custom fields to store data that enables personalized interactions, such as preferred communication methods or product interests.
- Seamless API Integration: Custom fields allow for seamless integration with APIs, ensuring that unique business data is captured and transferred efficiently to third-party systems or analytics tools
Forms page
You manage forms and fields on the Branding → Forms page in the Admin Console. The page has the following sections.
| Section | Purpose |
|---|---|
| Registration Form | Shows the fields on the registration form. Click Edit to open the Form Editor. |
| Custom Fields | Create and manage custom fields, up to 15 per tenant. At the limit, + New Custom Field is unavailable and shows Custom Fields Limit Reached. Custom fields appear under DATA FIELDS in the Form Editor. |
| Custom Objects | Lists custom objects. Click Show schema to view an object's schema as JSON. |
| Progressive Profiling | Lists Progressive Profiling steps and the fields each step requests. Appears only when the V2 template is deployed and is hidden when the V3 template is deployed. See Progressive Profiling. |
Configure a field
The Form Editor has three columns: the field library on the left, the form preview in the middle, and the field settings on the right. You add fields from the library, arrange them in the preview, and configure each one in the settings panel.
- On the Forms page, select Registration Form and click Edit. The Form Editor opens.
- Find the field in the left column. Use Search field names at the top of the column to narrow the list. The column groups fields into two collapsible sections:
- AUTHENTICATION FIELDS: the fields users sign in with, such as Email ID, Phone ID, Username, and Password.
- DATA FIELDS: all other fields. Rows tagged Advanced are repeatable groups, such as Addresses. Rows tagged Custom are fields you created. Untagged rows are standard profile fields.
- Click + on the field's card, or drag the card into the preview column and drop it where you want the field to appear. If the + is unavailable, hover over it to see the reason. For example, Confirm PIN cannot be added until PIN is on the form.
- Review the preview column, which shows the form in the order end users see it. Drag a field by the handle on its left edge to reorder it, or click the delete icon on its row to remove it.
- Click the field in the preview. Its settings open in the right column under the field's name.
- Configure the field as described in Field settings.
- Click Save changes in the top-right toolbar. Reset discards every unsaved edit and restores the form as it was last saved.
- Click Try to open the live registration page and verify the saved form. Try is unavailable while the form has unsaved edits. Recently saved changes can take a moment to appear.
Field settings
The settings panel lists the following settings for a single field.
| Setting | Description |
|---|---|
| Field ID | The stored attribute name. Read-only. |
| Display label | The label shown to end users. Must be 2 to 60 characters. |
| Input type | String, Text, Option, Checkbox, Password, or Email. |
| Options | Shown only when Input type is Option. Enter one key,value pair per line. |
| Validation string | The validation rules applied to the field. Click View validation rules for the supported rules. |
| Required | Makes the field mandatory. |
| Hidden | Collects the field with the form without showing it to users. |
| Read only | Shown only for custom fields. |
Required and Hidden are mutually exclusive. A hidden field cannot be required, and a required field cannot be hidden, so turn one off before you turn the other on.
If a switch does not move, hover over it to see the reason. For example, a sign-in field is always required, and a field managed on another page, such as Auth Configuration or PIN Authentication, cannot be removed from the Form Editor.
To remove the field from the form, click Remove field at the bottom of the settings panel.
Advanced fields
Advanced fields are repeatable groups, such as Addresses. For these fields, the settings panel shows a Group label and a Sub-fields list instead of a single set of settings.
Use each sub-field's switch to include or exclude it, and expand a sub-field to configure its own settings. At least one sub-field must stay included. The sub-field that identifies each entry, such as address type, is always included.