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

/citizen/_create

Body

RequestInfoobjectrequired

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.

Usersobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//citizen/_create' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Users":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

User(s) created sucessfully

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

/citizen/_update

Body

RequestInfoobjectrequired

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.

Usersobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//citizen/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Users":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Update user(s) successful

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

/citizen/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

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.

userNamestring · max: 64

The unique user name of the User.

activeboolean · varchar · default: true

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.

idinteger[]

List of Unique Id of User

userTypestring · max: 64

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

roleCodesstring[]

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

includeDetailsboolean

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

pageSizeinteger · max: 100 · default: 20

Number of records returned.

pageNumberinteger · default: 1

Page number

sortstring[] · default: ["+name"]

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

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//citizen/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Successful response

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

/v1/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

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.

userNamestring · max: 64

The unique user name of the User.

activeboolean · varchar · default: true

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.

idinteger[]

List of Unique Id of User

userTypestring · max: 64

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

roleCodesstring[]

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

includeDetailsboolean

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

pageSizeinteger · max: 100 · default: 20

Number of records returned.

pageNumberinteger · default: 1

Page number

sortstring[] · default: ["+name"]

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

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//v1/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Successful response

Create user without otp vallidation

End-point to create the user without otp validation.

post

/users/_createnovalidate

Body

RequestInfoobjectrequired

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.

Usersobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//users/_createnovalidate' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Users":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Update user(s) successful

Update user without otp vallidation

End-point to update the user without otp validation.

post

/users/_updatenovalidate

Body

RequestInfoobjectrequired

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.

Usersobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//users/_updatenovalidate' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Users":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Update user(s) successful

Update the profile of the user

End-point to create the user without otp validation.

post

/profile/_update

Body

RequestInfoobjectrequired

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.

Usersobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//profile/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Users":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Users": [
    {
      "tenantId": "text",
      "id": 1,
      "userName": "text",
      "authToken": "super-secret",
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "aadhaarNumber": "text",
      "active": true,
      "pwdExpiryDate": 1,
      "locale": "text",
      "type": "text",
      "accountLocked": false,
      "userDetails": {},
      "auditDetails": {},
      "roles": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Update user(s) successful

The user can update his password after login

This API used for update the password after login

post

/password/_update

Body

RequestInfoobject

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.

existingPasswordstringrequired

Existing password

newPasswordstringrequired

New password

tenantIdstringrequired

Unique Identifier of the tenant to which user primarily belongs

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//password/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"existingPassword":"text","newPassword":"text","tenantId":"text"}'

200

400

200

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

Updated password 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

/password/nologin/_update

Body

RequestInfoobject

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.

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

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//password/nologin/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"otpReference":"text","userName":"text","newPassword":"text","tenantId":"text"}'

200

400

200

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

Updated password successful

Logout user

End-point to create the user without otp validation.

post

/_logout

Body

accessTokenstring

access-token required for authentication

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users//_logout' \
  --header 'Content-Type: */*'

200

400

200

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

logout successful