Problem statement:
Sunbird system will allow user on-boarding with following ways:
- Self sign up
- Google plus login
- State login
Problem will have during user profile merging. Migrating self sign up user profile with Google plus login or state login.
User attribute required during sign up:
Attribute | Type | Required | purpose |
---|---|---|---|
name | string | true | name of user. can be combination of firstname , middle name and lastname |
username | alphanumeric | true | unique identity to identify user. user name will be unique per installation |
password | alphanumeric | true | |
phone | number | conditional | either phone or email is mandatory . but during creation time user can't pass both. |
alphanumeric | conditional | either phone or email is mandatory . but during creation time user can't pass both. | |
userType | string | internal | To identify user is Teacher or Other , as of now there is only two types |
signUpType | string | internal | To identify user came via selfsignUp, googleplus , statelogin or stateonboard |
phoneVerified | boolean | internal |
Self sign up work flow:
- User will enter all mandatory field (name, phone/email, username,password) on consumer portal/app
- Consumer will make call for generate OPT for either phone or email
- OTP Generation will be taken care by Design for One time password (OTP)
- Once User enter OTP, consumer will check OTP basic Validation and then it will call create user APi:
- System will check uniqueness of email/phone , username and OTP , if every thing is ok then it will create user under sunbird.
- if any validation fails then it will throw proper error
Create User api request body:
URI: v3/user/create
Method: POST
Request body:
{
"request":
Unknown macro: { "firstName"}
}
Note:
- is username is auto generated unique value or user has to enter it
- Do we need to take orgId or channel in create user to associate user with another rootOrg,.
- How to do validation for Indian phone number. As per PRD only Indian phone number is valid.
- Are we taking country code as well from user , or always will associate user country code as "+91"