...
Universal Controller supports the following RESTful-based web services for User operations, which are listed alphabetically on this page.
- User Web Services#Create a User
- User Web Services#Delete a User
- User Web Services#List Users
- User Web Services#Modify a User
- User Web Services#Read a User
...
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 | ||||
---|---|---|---|---|
|
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 |
|
...
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 | |
Example Response |
|
...
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 | |
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. |
Anchor | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/user |
HTTP Method | PUT |
Description | Modifies the User specified by the sysId in the request. |
Example URI | http://localhost:8080/uc/resources/user |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | |
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 |
|
...
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 | |
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 |
|
...