Universal Controller supports the following RESTful-based web services for User operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Permissions

The following table identifies the web service operations that a user can perform

Operation	User without any role	User with service role	User with user_admin or admin role
Read	Read its own record.	Read any fields.	Create/update/read/delete any fields or any related data.
Update	Update a subset of fields of its own record. Cannot update any related data	Update a subset of fields of its own record. Cannot update any related data.
Create	No permission to create a user.	No permission to create a user.
Delete	No permission to delete a user.	No permission to delete a user.

Anchor
Create a User
Create a User
Create a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method
Description	Creates a new User.
Example URI	http://localhost:8080/uc/resources/user
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Create, Modify, and Read a User: XML and JSON Examples: XML and JSON Examples, below.
User Properties	See User Web Services#User Properties, below.
User Permission Properties	See User Web Services#User Permission Properties, below.
User Role Properties	See User Web Services#User Role Properties, below.
Example Response	Status 200 /OK Successfully created the user with sysId {sysId}.

...

	Description
URI	http://host_name/uc/resources/user
HTTP Method	DELETE
Description	Deletes a User.
URI Parameters	See User Web Services#Delete Delete a User URI Parameters, below.
Example URI	http://localhost:8080/uc/resourcess/user?username=Test_User_Name http://localhost:9080/uc/resources/user?userid=18fcf558002743e38edc49114734b6d9
Example Response	Status 200 /OK User {username} deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify userid and username at the same time. Status 404 /Not Found User with {username/userid} does not exist.

...

	Description
URI	http://host_name/uc/resources/user/list
HTTP Method	GET
Description	Retrieves information on all Users.
Example URI	http://localhost:8080/uc/resources/user/list
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example	See List Users: XML and JSON Examples.
User Properties	See #User Properties.
User Permission Properties	See User Web Services#User Permission Properties.
User Role Properties	See User Web Services#User Role Properties.

...

	Description
URI	http://host_name/uc/resources/user
HTTP Method	PUT
Description	Modifies the User specified by the sysId in the request. To modify User properties without modifying related records, see the excludeRelated property.
Example URI	http://localhost:8080/uc/resources/user
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Create, Modify, and Read a User: XML and JSON Examples.
User Properties	See User Web Services#User Properties.
User Permission Properties	See User Web Services#User Permission Properties.
User Role Properties	See User Web Services#User Role Properties.
Example Response	Status 200 /OK Successfully updated the user with sysId <sysId>.

...

	Description
URI	http://host_name/uc/resources/user
HTTP Method	GET
Description	Retrieves information on a specific User.
URI Parameters	See Read a User: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/user?username=test.user http://localhost:8080/uc/resources/user?userid=c489750500d444eca9325559d0ef9673
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
User Properties	See User Web Services#User Properties.
User Permission Properties	See User Web Services#User Permission Properties.
User Role Properties	See User Web Services#User Role Properties.
Example Response	Status 200 /OK (See Create, Modify, and Read a User: XML and JSON Examples.) Status 404 /Not Found A user with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

...