Schemas

The registration fields are used to create a customized format for the registration process. Tenants can design their own registration format according to their preferences.

Accessing Registration Fields in the Admin Console

1. Open the Admin Console.

2. On the left-hand side, look for and click on Settings.

3. In the Settings section, click on the Registration Fields tab.

4. On the right-hand side of the Registration Fields tab, you will see a list of already added Registration Fields.

Creating Registration Fields

Note: The registration field is customizable by the tenant for the user registration page setup.

1. In the top-right corner, you will find a Create Field button.

2. To create new Registration Fields, click on this Create Field button.

1. Clicking the Create Field button will redirect you to the Create Field page.

Sections in the Create Field Page

1.FIELD DETAILS

1.1 Field Key

• A field key, also known as a key field, is a unique identifier for a specific data field within a record. It's used to uniquely identify each individual record.

1.2Field Type

• Field type refers to the data type or format of the information stored in a particular field.

• Different field types are used to represent different kinds of data, such as text, numbers, dates, Booleans, and more.

• The choice of field type depends on the nature of the data being stored and the operations that need to be performed on that data.

2.LOCALE DETAILS

• This section probably focuses on settings related to different languages and locales.

• Skill authenticator flows often need to accommodate users from various regions who may prefer different languages.

• In this section, you might be able to customize the content, labels, and messages displayed on the hosted page based on the user's preferred language or locale.

Using the Select Locale Field and Filling in Details

1. The Select Locale field is used to choose your preferred locale, and you can select multiple locales if needed.

1. Two fields, namely Display Name and Required Message, are mandatory and must be filled in.

2. The fields Max Length, Min Length, and Match With are optional.

3. If you want to set a maximum length, input the desired value in the respective input box.

4. Similarly, for the Min Length and Match With fields, provide input values as needed.

5. Your entered values will be saved according to the configurations you've set.

3.FIELD ATTRIBUTES

• Enabled: This attribute determines whether the field is active or not. If enabled, the field can be interacted with; if disabled, it becomes inactive.

• Internal: When set, this attribute signifies that the field is for internal use and might not be visible or editable to external users or stakeholders.

• Read-only: This attribute prevents user-editing. If enabled, the field can only be viewed but not modified.

• Required: Enabling this attribute makes filling out the field mandatory. Users must provide input for this field; otherwise, they cannot proceed until it's completed.

• Hidden: This attribute allows you to hide the field from view. Users won't be able to see or interact with it.

4. SCOPE DETAILS

1. In the Scope Details section, understand that Scope refers to the extent or range of authority.

2. Use the Select Scopes field to choose your preferred scope. You have the option to select multiple scopes if needed.

3. After completing all the fields mentioned in the previous sections (such as FIELD DETAILS, LOCALE DETAILS, and FIELD ATTRIBUTES), ensure you've filled in all the required information.

1. Once all fields are properly filled, locate and click the Save button.

2. This action will save the field you've newly entered, along with the scope details you've specified.

Create Group

Note: The tenant can customize the field groups for the user registration page setup, such as the Address group, which includes fields like Street Name and Pin Code, among others.

1. Locate the Create Group button in the top right corner.

2. Click this button to initiate the process of creating a new Registration field group.

1. Clicking the Create Group button will redirect you to the Create Field page.

The Create Group page contains four sections

1.FIELD DETAILS:

1.1 Field Key

• A field key, also known as a key field, is a unique identifier for a specific data field within a record. It's used to uniquely identify each individual record.

1.2 Field Type

• Field type refers to the data type or format of the information stored in a particular field.

• Different field types are used to represent different kinds of data, such as key value, list.

2.LOCALE DETAILS

This section probably focuses on settings related to different languages and locales. Skill authenticator flows often need to accommodate users from various regions who may prefer different languages. In this section, you might be able to customize the content, labels, and messages displayed on the hosted page based on the user's preferred language or locale.

1. Use the select locale field to choose your preferred locale.

2. You can select multiple locales if needed.

3. Ensure that the Display Name field is filled in; this is a required field.

3.FIELD ATTRIBUTES

Enabled: This attribute determines whether the field is active or not. If enabled, the field can be interacted with; if disabled, it becomes inactive.

Internal: When set, this attribute signifies that the field is for internal use and might not be visible or editable to external users or stakeholders.

4.SCOPE DETAILS

Scope refers to the extent or range of authority.

1. Scope Definition: Scope refers to the extent or range of authority or access.

2. Selecting Scopes: Use the select scopes field to choose your preferred scope, and you can select multiple scopes if necessary.

3. Saving Changes: After completing all the fields mentioned above, click the Save button to save your newly entered field.

Add New Group

1. Navigate to the Registration Fields -> Field List page, where you'll find a list of previously created fields.

2. Select your desired option from the list.

3. Click on the Add new group icon. This action will redirect you to the Create Field page.

4. Complete all the required fields on the Create Field page.

5. Save your changes. This process will successfully create the new group under the existing field.

Add New Field

1. Navigate to the Registration Fields -> Field List page, where you'll find a list of previously created fields.

2. Select your desired field from the list.

3. Click on the Plus icon. This action will redirect you to the Create Field page.

4. Complete all the required fields on the Create Field page.

5. Save your changes. This process will successfully create the new field under the existing field.

Edit Field

1. Locate the field you want to edit.

2. Click on the pencil icon next to that field. This action will redirect you to the Update Field page.

3. Make the necessary changes to the field settings.

4. Click the Save button. This action will save your changes.

Delete Field

1. Go to the Update Field page for the field you want to delete.

2. Scroll down to the DANGER ZONE section.

3. Click the delete button. This action will remove the field.