The user registration form, which is also known as the sign up form, is generated using claims and is primarily used to gather user information which is used by ES. The As the information required by business entities will differ based on their strategies. Therefore, WSO2 ES facilitates the option for the administrator to customize the registration form to suite the entities business requirements.
Info |
---|
As ES is built on top of WSO2 Carbon. The , the user registration form is populated by claims which are mapped through WSO2 Carbon. There are several claims configurations in Carbon and for self signup ES uses ; however, only the following default Carbon claim which is the default dialect for WSO2 Carbondialect is used for self signup (registration) in ES: http://wso2.org/claims |
The following screenshot depicts the fields in the default ES user registration form.
...
- Adding a new claim mapping
This allows you to add a new field in the user registration form. When adding the claim mapping for the new claim, you need to select the required checkbox for , so that the claim to will appear as a field in the user registration form. - Editing a claim mapping
If you wish to edit the fields in the user registration form (such as, change the order or a field, hide a field etc.), then you can edit the claims that respective claim mappings, which correspond to those fields in the user registration form. - Deleting a claim mapping
If you do not want a certain field to permanently appear in the user registration form, then can delete the claim mapping that corresponds to that field.
...
Follow the instructions below to add a new claim mapping:
- On the Main menu, click Claim Management.
Click http://wso2.org/claims under AVAILABLE CLAIM DIALECTS.
The available claims under the claim mappings that correspond to the selected claim dialect that you selected appears.
- Click Add New Claim Mapping to add a new claim mapping that does not already exist.
Fill Enter the details required in the fields of the NEW CLAIM DETAILS form.
Excerpt The fields related to claim details are explained as follows:
Info icon false Display Name: Name of the dialect.Description: Describe the dialect, such as, what it is designed for, etcThis is the name of the claim displayed on the UI.
Description: This gives you the option to describe the functionality of the claim.
Claim Uri: Each dialect should have at least one claim when defining itThis is the URI defined under the dialect, specific to the claim. There are different URIs available in Carbon and these equate to user attributes displayed in the profile of users. These URIs are mapped to the attributes in the underlying user store.
Mapped Attribute: Corresponding This is the corresponding attribute name from the underlying user store for this claim.Regular Expression: Regular expression that is mapped to the Claim Uri value. When you have multiple user stores connected to ES, this maps the equivalent attribute in all of them to the Claim Uri you are configuring. For example, if you specify the
cn
attribute, this is mapped to thecn
attribute in all the connected user stores. If you want to specify the attribute in a specific user store, you must add the domain name in addition to the mapped claim. For example, in a scenario where you have a primary user store configured called PRIMARY and secondary user stores called AD (representing Active Directory) and JDBC, you can map an attribute from each of these user stores to the Claim Uri value by entering them in a semi-colon separated list. In this example, your Mapped Attribute value would read as follows:PRIMARY/attribute1;AD/attribute2;JDBC/attribute3
.Regular Expression: This is the regular expression used to validate inputs for this claim.
Display Order: Display order of the above claim among all This enables you to specify the order in which the claim is displayed, among the other claims defined under the same dialect.
Supported by Default: If unchecked, this claim will not be prompted at the time of during user registration.
Required: Whether This specifies whether this claim is mandatory required for user registration or not. Note that the The claim will only appear in the user registration form if this field is checked.
- Read-only: This specifies whether the claim once added at the time of registration can or can not be modified later when updating user details. If a claim is read-only, ES will not allow you to update the field corresponding to it when updating the corresponding user's details.
- Click Add to add the new claim mapping.
Editing a claim mapping
Follow the instructions below to update a claim mapping:
- On the Main menu, click Claim Management.
Click http://wso2.org/claims under AVAILABLE CLAIM DIALECTS. The available claims under the claim mappings that correspond to the selected claim dialect that you selected appears.
Click Edit corresponding to the claim mapping that you want to edit.
- Edit the required fields of in the UPDATE CLAIM DETAILS form. Note that the claim Uri can not be updated.
Insert excerpt Customizing the User Registration Form Customizing the User Registration Form nopanel true - Click Update to save the changes made.
Navigate to the ES Store or Back Office (Publisher) and click Register to access the registration page and . Thereafter, refresh the registration page to view the customized registration form with the newly added customizations.
Deleting a claim mapping
Follow the instructions below to delete a claim mapping:
- On the Main menu, click Claim Management.
Click http://wso2.org/claims under AVAILABLE CLAIM DIALECTS. The available claims under the claim mappings that correspond to the selected claim dialect that you selected appears.
Click Remove claim mapping corresponding to the claim that you want to delete.
- Click yes to delete the selected claim mapping.