openspecimen/rest/ng/users
Use this resource to create new user in the openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| firstName | First name of the user |
| lastName | Last name of the user |
| emailAddress | Email Address of the user. This attribute should be unique in openSpecimen application |
| phoneNumber | Phone number of the user, By default it will be blank |
| domainName | Name of the authentication domain . For providing domain name, domain should be already registered in application. By default its openSpecimen in application |
| loginName | Login Name through which user can login to openSpecimen application, should be unique in authentication domains |
| deptName | Name of department to which user belongs |
| admin | Set user as superadmin. values are {true, false}. |
| address[optional] | Address of the user |
| activityStatus | Activity status of the user, permissible values are {active, closed, pending, disabled} |
http[s]:<host>:<port>/openspecimen/rest/ng/users
Use this URL to add user in openSpecimen application.
Result:
The response of this request will contains the details of the created user.
Below is the example of the create user:
| URL | http://<host>:<port>/openspecimen/rest/ng/users |
| Method | POST |
| Request | application/json |
| json | {
"id": 1,
"lastName": "Admin",
"firstName": "Admin",
"domainName": "openspecimen",
"emailAddress": "admin@admin.com",
"phoneNumber": "1234567890",
"loginName": "admin@admin.com",
"activityStatus": "Active",
"deptName": "Immunology",
"admin": true,
"address": null
}
|
Response | {
"id": 1,
"lastName": "Admin",
"firstName": "Admin",
"domainName": "openspecimen",
"emailAddress": "admin@admin.com",
"phoneNumber": " 1234567890",
"loginName": "admin@admin.com",
"siteNames":
[
],
"creationDate": null,
"activityStatus": "Active",
"instituteName": "A1 - For Demo Users",
"deptName": "Immunology",
"admin": true,
"address": null
}
|
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | User has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate login name, duplicate email address, blank first name etc |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |