Registration

Registration allows an Administrator to define the fields for user to fill the registration form. The standard field designations are modified as per the requirement. Additionally, business requirement specific details are added.

Here one can define the expected input format and specify if the new field is a required. This is what allows for a dynamic extension of the UI Registration. Scopes are mapped to a field as well.

cidaas dashboard -> Settings -> “Registration”.

The created registration grid table screen gets displayed, as in the below screen

Note To drag and drop the field name, click on the icon.

Default Fields

By default, cidaas provides the below mentioned fields:

  • Email

  • Given Name

  • Family Name

  • Password

  • Confirm Password

  • Mobile

Create Field

To create custom fields,

1. From the registration setup screen, right handside top corrner click “Create Field” button.

2. The Field Setting screen gets displayed as in the below screen

3. Enter the field name.

4. Select the appropriate field type from the drop down.

5. Enter the field key

6. Select the appropriate scopes from the drop down (user can select multiple scopes), as in the below screen,

For more information refer Scope Management.

Mapping scopes to registration fields

We can map scopes to a specific registration field - notice the map scopes drop down option. One field could have more than one scope. Many fields can be grouped based on scope when they are mapped to the same scope.

For e.g. First Name, Last Name and Email could each be mapped with the “profile” scope. Date of birth is a field that can be mapped to the “profile” scope as well as “personal” scope. Or credit card field can be mapped with a scope called “payment”.

So, when an application request contains the “profile” and “payment” scope, only such data from the fields that have the same scope associated with them, will be allowed access.

The concept is depicted in the diagram below:

Access restrictions can therefore be implemented on a set of fields, by grouping them based on scope.

Fig shows the registration set up page, where custom fields can be defined and scopes can be associated.

7. Select the appropriate checkbox against enable/required/read only. If the enable checkbox is not selected then user is not able to see the activity in the registration page.

8. Under locale settings, select the appropriate locale and enter field name based on locale.

9. Enter a brief description.

Note Depending on the field type user can add attributes to the field.

Find the below table for reference:


Fields Description

Data Type

defines the datatype of a field. The datatype options are defined in the above enumeration Datatype

Field Key

unique identifier of the fieldSetup

Select Scopes

defines the scope of the registration field, Access token having scopes should match with the registration field scope, then only the value of the field should be given in the user profile API. Refer: Scope Management.

Field Definition

defines constraints for a field

Checkbox


Enable: marks a field as active
Required: Mandatory field which needs to be filled while registering to cidaas.
ReadOnly:marks a field as only readable. Fields with readOnly:true are only readable for users, admins should also be able to edit this fields. Should be marked as readOnly in Admin-UI.
Internal: defines the visibility of the field: the field is used only for internal purposes, we won't expose this field in the public registration field list and is not visible for users. Should be editable for admin-user.
Order: defines the order of the registration field shown in UI.

Assignment of data type and base data type:

Data Types Base DataTypes

TEXT

string

NUMBER

double/integer

RADIO

string

CHECKBOX

boolean

PASSWORD

string

DATE

datetime

URL

string

EMAIL

string

TEXTAREA

string

MOBILE

string

JSON_STRING

string

USERNAME

string

CONSENT

boolean

Array

array

SELECT

string

MULTISELECT

array[string]

10. Click “Save” button, a message window popup “Field saved successfully”, click “OK” button

11. The created field get displayed under the registration grid table, as in the below screen

12. Once the fields are created the same fields are available during the Registration Form /Signup to cidaas, and under the Create User section as in the below screen,

Edit Field

To make appropriate changes in to the created field follow the below steps:

1. From the existing field, click “Edit” button, the below screen gets displayed,

2. Once the appropriate changes made, click “Save” button, a message window popup “Field Saved Successfully”.

Delete Field

1. From the existing user click “Edit” button, the below screen gets displayed,

2. Click “Delete” button, the below confirmation screen gets displayed,

3. Click “YES” to confirm the delete, a message window gets displayed, “Field Deleted Successfully”.

4. Click “NO” to cancel the delete.



results matching ""

    No results matching ""