URI
<users_uri>/{username}[.<format>]
Supported methods
Parent resource
Introduction
Specify user's personal information
Supported Methods:
- GET: Gets the specified user's personal information.
- HEAD: Check whether the user resource exists. or to access the user resource.
Supported formats: rjson, json, html, xml.
Resource hierarchy
HTTP request methods
Implement the HTTP request on the following URI, where supermapiportal is the server name, with rjson being the output format.
http://supermapiportal:8090/iportal/web/users/{username}.rjson
GET request
Gets the specified user's personal information.
Response structure
Execute GET request for user resource, and get the specified user's personal information. The returned representation of a single resource is as follows:
| Field | Type | Description |
| description | String | User description info. |
| String | The email address of user. | |
| name | String | Username. |
| nickname | String | Nick name. |
| ownRoles | String[] | The user roles, not including the role in the user group. |
| password | String | The user password. |
| passwordQuestion | IportalPasswordQuestion | It is used to reset password for the security questions and answers |
| roles | String[] | User associated roles. |
| userGroups | String[] | The user group. |
Response example
The returned rjson format representation after implementing the GET request on the user resource http://localhost:8090/iportal/web/users/admin.rjson is as follows:
{
"description": null,
"email": null,
"name": "admin",
"nickname": "admin",
"ownRoles": null,
"password": null,
"passwordQuestion": {
"pwdAnswer": null,
"pwdQuestion": "school"
},
"roles": null,
"userGroups": null
}
HEAD request
Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.
HEAD request can be used to check if the user resource exists, or if the user resource can be accessed by clients. It can also determine if the user resource supports an output format <format> if performed on a URI with .<format> included.