User

User Management and Authentication

Swagger Editor

Swagger API Contract Link

Create a new User.

post

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.

Body

Responses

201

User(s) created sucessfully

application/json

400

User(s) creation failed

application/json

post

HTTPcURLJavaScriptPython

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-06-13",
        "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-06-13",
        "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
      }
    }
  ]
}

Update user API

post

This API will update all user related details based on their type. Following rules apply -

1. Username cannot be updated once created
2. Password can only be updated by the user itself (CITIZEN or EMPLOYEE) using reissue OTP issued to them
3. User can self update mobile number/email by doing OTP verification with old phone/email
4. An employee can reset another user mobile number/email after OTP/other necessary validation (need specific privilege)

Body

Responses

200

Update user(s) successful

application/json

400

Update user(s) failed

application/json

post

HTTPcURLJavaScriptPython

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-06-13",
        "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-06-13",
        "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 the users in the system based on the criterion specified.

post

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

body

requestInfoanyOptional

Parameter to carry Request metadata in the request body

Query parameters

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

userNameanyOptional

The unique user name of the User.

activeanyOptional

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.

idanyOptional

List of Unique Id of User

userTypeanyOptional

Defines the type of user. Possible values are as per type enum defined in User object.

roleCodesanyOptional

roles assigned to the user(roleCodes).Search response will have all users having all roles specified in the request.

includeDetailsanyOptional

parameter to indicate whether UserDetails should be included as a part of User object in the response

pageSizeanyOptional

Number of records returned.

pageNumberanyOptional

Page number

sortanyOptional

User results will be sorted by name ascending by default if this parameter is not provided.

Responses

200

Successful response

application/json

400

Invalid input.

application/json

post

HTTPcURLJavaScriptPython

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-06-13",
        "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
      }
    }
  ]
}

The user can update his password after login

post

This API used for update the password after login

Body

existingPasswordstringRequired

Existing password

newPasswordstringRequired

New password

tenantIdstringRequired

Unique Identifier of the tenant to which user primarily belongs

Responses

200

Updated password successful

application/json

400

Updated password failed

application/json

post

HTTPcURLJavaScriptPython

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 act as reset password or forgot password before login

post

This API used for reset the password when user forgot his password by getting otp Reference through registerd mobile number,

Body

otpReferencestringRequired

otp reference number which sent to registered mobile

userNamestringRequired

Registered User name

newPasswordstringRequired

New password

tenantIdstringRequired

Unique Identifier of the tenant to which user primarily belongs

Responses

200

Updated password successful

application/json

400

Updated password failed

application/json

post

HTTPcURLJavaScriptPython

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"
  }
}