User

User Services APIs

Create, update and search users. Users encompass any user interacting with the system such as citizens, employees, contractors, vendors, etc.

Create a new User.

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//citizen/_create

Body

*/*

Details for the new user + RequestInfo meta data

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Users*array of User (object)

Response

201400

User(s) created sucessfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//citizen/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "Users": [
        {
          "active": false,
          "gender": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

Update user API

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)

POST/users//citizen/_update

Body

*/*

Request header for the user with new of values.

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Users*array of User (object)

Response

200400

Update user(s) successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//citizen/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "Users": [
        {
          "active": false,
          "gender": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

Search the users in the system based on the criterion specified.

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

POST/users//citizen/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//citizen/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

Search the users in the system based on the criterion specified.

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

POST/users//v1/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Successful response

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//v1/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

Create user without otp vallidation

End-point to create the user without otp validation.

POST/users//users/_createnovalidate

Body

*/*

Details for the new user + RequestInfo meta data

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Users*array of User (object)

Response

200400

Update user(s) successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//users/_createnovalidate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "Users": [
        {
          "active": false,
          "gender": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

Update user without otp vallidation

End-point to update the user without otp validation.

POST/users//users/_updatenovalidate

Body

*/*

Details for the new user + RequestInfo meta data

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Users*array of User (object)

Response

200400

Update user(s) successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//users/_updatenovalidate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "Users": [
        {
          "active": false,
          "gender": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

Update the profile of the user

End-point to create the user without otp validation.

POST/users//profile/_update

Body

*/*

Details for the new user + RequestInfo meta data

RequestInfo*RequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Users*array of User (object)

Response

200400

Update user(s) successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Usersarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('/users//profile/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "Users": [
        {
          "active": false,
          "gender": "text",
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "userName": "text",
      "authToken": "password",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": false,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "roles": [
        {
          "name": "text",
          "description": "text"
        }
      ],
      "userDetails": {
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "dob": "2024-11-21",
        "altContactNumber": "text",
        "fatherName": "text",
        "husbandName": "text",
        "bloodGroup": "text",
        "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"
      }
    }
  ]
}

The user can update his password after login

This API used for update the password after login

POST/users//password/_update

Body

*/*

Request header for the user with new of values.

RequestInfoRequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

existingPassword*string

Existing password

newPassword*string

New password

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

Response

200400

Updated password successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Request

JavaScriptCurlPython

const response = await fetch('/users//password/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "existingPassword": "text",
      "newPassword": "text",
      "tenantId": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

This API act as reset password or forgot password before login

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

POST/users//password/nologin/_update

Body

*/*

Request header for the user with new of values.

RequestInfoRequestInfo (object)

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

otpReference*string

otp reference number which sent to registered mobile

userName*string

Registered User name

newPassword*string

New password

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

Response

200400

Updated password successful

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Request

JavaScriptCurlPython

const response = await fetch('/users//password/nologin/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "newPassword": "text",
      "otpReference": "text",
      "tenantId": "text",
      "userName": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Logout user

End-point to create the user without otp validation.

POST/users//_logout

Body

*/*

Details for the new user + RequestInfo meta data

accessTokenstring

access-token required for authentication

Response

200400

logout successful

Body

*/*

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

Request

JavaScriptCurlPython

const response = await fetch('/users//_logout', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "apiId": "text",
  "ver": "text",
  "resMsgId": "text",
  "msgId": "text",
  "status": "SUCCESSFUL"
}