User
User Management and Authentication
To create new User(s) in the system. API supports bulk creation with max limit as defined in the UserReq. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one user, please pass array with one user object.
Users can be created based on the roles. Users with types as SYSTEM and EMPLOYEE can create other users if their RBAC mapping provides them the permission. Users with CITIZEN type can only create themselves, while EMPLOYEE and SYSTEM type users can also create other EMPLOYEES and CITIZENS.
User registration will always be a two step process, where this API will create a non authenticated user (without password) and after verification (using OTP) other user details (including password) can be updated using update user API to complete the user registration process.
POST /users/v110/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 879
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Users": [
{
"tenantId": "text",
"id": 1,
"userName": "text",
"authToken": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"aadhaarNumber": "text",
"active": true,
"locale": "text",
"type": [
"EMPLOYEE"
],
"accountLocked": false,
"roles": [
{
"name": "text",
"description": "text"
}
],
"userDetails": {
"firstName": "text",
"middleName": "text",
"lastName": "text",
"dob": "2025-07-04",
"altContactNumber": "text",
"fatherName": "text",
"husbandName": "text",
"bloodGroup": [
"A+"
],
"pan": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"signature": "text",
"identificationMark": "text",
"photo": "text"
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Users": [
{
"tenantId": "text",
"id": 1,
"userName": "text",
"authToken": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"aadhaarNumber": "text",
"active": true,
"pwdExpiryDate": 1,
"locale": "text",
"type": [
"EMPLOYEE"
],
"accountLocked": false,
"roles": [
{
"name": "text",
"description": "text"
}
],
"userDetails": {
"firstName": "text",
"middleName": "text",
"lastName": "text",
"dob": "2025-07-04",
"altContactNumber": "text",
"fatherName": "text",
"husbandName": "text",
"bloodGroup": [
"A+"
],
"pan": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"signature": "text",
"identificationMark": "text",
"photo": "text"
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}This API will update all user related details based on their type. Following rules apply -
- Username cannot be updated once created
- Password can only be updated by the user itself (CITIZEN or EMPLOYEE) using reissue OTP issued to them
- User can self update mobile number/email by doing OTP verification with old phone/email
- An employee can reset another user mobile number/email after OTP/other necessary validation (need specific privilege)
POST /users/v110/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 879
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Users": [
{
"tenantId": "text",
"id": 1,
"userName": "text",
"authToken": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"aadhaarNumber": "text",
"active": true,
"locale": "text",
"type": [
"EMPLOYEE"
],
"accountLocked": false,
"roles": [
{
"name": "text",
"description": "text"
}
],
"userDetails": {
"firstName": "text",
"middleName": "text",
"lastName": "text",
"dob": "2025-07-04",
"altContactNumber": "text",
"fatherName": "text",
"husbandName": "text",
"bloodGroup": [
"A+"
],
"pan": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"signature": "text",
"identificationMark": "text",
"photo": "text"
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Users": [
{
"tenantId": "text",
"id": 1,
"userName": "text",
"authToken": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"aadhaarNumber": "text",
"active": true,
"pwdExpiryDate": 1,
"locale": "text",
"type": [
"EMPLOYEE"
],
"accountLocked": false,
"roles": [
{
"name": "text",
"description": "text"
}
],
"userDetails": {
"firstName": "text",
"middleName": "text",
"lastName": "text",
"dob": "2025-07-04",
"altContactNumber": "text",
"fatherName": "text",
"husbandName": "text",
"bloodGroup": [
"A+"
],
"pan": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"signature": "text",
"identificationMark": "text",
"photo": "text"
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Search and get user(s) based on defined search criteria. Currently search parameters are only allowed as HTTP query params. In case multiple parameters are passed user will be searched as an AND combination of all the parameters. Maximum result size is restricted based on the maxlength of Users as defined in UserRes model.
By default results will be sorted by UserName
Parameter to carry Request metadata in the request body
Unique id for a tenant.
epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.
The unique user name of the User.
True will be set in cases where only active users are needed and False will be set when inactive users are needed and no value will be set when all users are needed.
List of Unique Id of User
Defines the type of user. Possible values are as per type enum defined in User object.
roles assigned to the user(roleCodes).Search response will have all users having all roles specified in the request.
parameter to indicate whether UserDetails should be included as a part of User object in the response
Number of records returned.
Page number
User results will be sorted by name ascending by default if this parameter is not provided.
POST /users/v110/_search?tenantId=null HTTP/1.1
Host:
Accept: */*
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Users": [
{
"tenantId": "text",
"id": 1,
"userName": "text",
"authToken": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"mobileNumber": "text",
"emailId": "text",
"aadhaarNumber": "text",
"active": true,
"pwdExpiryDate": 1,
"locale": "text",
"type": [
"EMPLOYEE"
],
"accountLocked": false,
"roles": [
{
"name": "text",
"description": "text"
}
],
"userDetails": {
"firstName": "text",
"middleName": "text",
"lastName": "text",
"dob": "2025-07-04",
"altContactNumber": "text",
"fatherName": "text",
"husbandName": "text",
"bloodGroup": [
"A+"
],
"pan": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"signature": "text",
"identificationMark": "text",
"photo": "text"
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}This API used for update the password after login
Existing password
New password
Unique Identifier of the tenant to which user primarily belongs
POST /users/v110/password/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 214
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"existingPassword": "text",
"newPassword": "text",
"tenantId": "text"
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}This API used for reset the password when user forgot his password by getting otp Reference through registerd mobile number,
otp reference number which sent to registered mobile
Registered User name
New password
Unique Identifier of the tenant to which user primarily belongs
POST /users/v110/password/nologin/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 228
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"otpReference": "text",
"userName": "text",
"newPassword": "text",
"tenantId": "text"
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Last updated
Was this helpful?