Create User

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 the application. By default its `openSpecimen` in application
loginName	Login Name through which a user can log in to the OpenSpecimen application should be unique in authentication domains
instituteName	Name of the department to which the user belongs
type	Type of the user: Super Administrator → "SUPER" Institute Administrator → "INSTITUTE" Regular User → "NONE" Contact User → "CONTACT"
address[optional]	Address of the user
activity status	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", "type": "SUPER", "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", "type": "SUPER", "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