You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: oidc-ui/README.md
+25Lines changed: 25 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,31 @@ Esignet UI contains the following pages:
34
34
35
35
The initialization of the component on this page is contingent upon the authentication factors received from the oauth-details endpoint. These authentication factors are determined based on the acr_values parameter specified in the authorize request.
36
36
37
+
Each authentication method, except KBI, allows users to log in using configured multiple ID types such as Mobile Number, NRC ID, VID, and Email, with support for both prefixes and postfix.
38
+
39
+
- Configuration Details:
40
+
The configuration for rendering multiple login IDs is defined in the application-default.properties file of the esignet-service. If mosip.esignet.ui.config.login-id.options is set to an empty string, null, or an empty array, the UI defaults to using VID login as the fallback login ID.
- Each ID configured in `mosip.esignet.ui.config.login-id.options` will create a button for the user to select and use as a login ID type.
51
+
52
+
- To update the language for buttons, input labels, and placeholders, modify the loginOptions object in the i18n bundle files. Ensure that any new ID added to the configuration is consistently defined with the same ID name across the buttons, input labels, and placeholders objects within the i18n bundle files.
53
+
54
+
- The svg value specified in the configuration must match the name of the SVG icon located in the images folder to ensure proper rendering in the UI.
55
+
56
+
- The prefix should be either plain text or an array of objects to support multiple prefixes.
57
+
For mobile login with multiple prefixes, it is recommended to use the ISO 3166-1 alpha-3 country code as the label in the configuration. This code will be used to display the corresponding country flag in the UI. (Reference: [ISO 3166-1 country codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)).
58
+
The postfix should always be a single text value.
59
+
60
+
- The maxLength and regex properties are optional for prefixes. If specified within a prefix, the values from the prefix will take precedence; otherwise, the outer values will be used. This follows a scope hierarchy where the inner scope takes priority over the outer scope.
61
+
37
62
The password-based authentication system incorporates a functionality allowing users to initiate a password recovery process through a designated `Forgot Password` hyperlink.
38
63
39
64
For knowledge based identification, the form schema is defined in the property : 'auth.factor.kbi.field-details'.
0 commit comments