URI

<users_uri>/{username}[.<format>]

Supported methods

GET, HEAD

Parent resource

users

Child resources

hasPwdQuestion, isPwdAnswer, pwdQuestion, resetPassword, updateUserExtendAttrs

Introduction

Personal profile information of the specified user.

Supported Methods:

  • GET: Get the personal profile information of the specified user.
  • HEAD: Checks whether the user resource exists or whether it has permission to access the user resource.

Supported output 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:8190/iportal/web/users/{username}.rjson

GET request

Get the personal profile information of the specified user.

Response structure

Execute GET request for the user resource to get the personal profile of the specified user. The basic structure of the returned single resource representation is as follows:  

Field Type Description
email String The email address of the user.
name String The username.
nickname String The nickname of the user.
passwordQuestion IportalPasswordQuestion The security question and answer used to reset the password.
thumbnail String The path of the user avatar.
type String The user type.

Response example

The returned rjson format representation after implementing the GET request on the user resource http://localhost:8190/iportal/web/users/admin.rjson is as follows, where some fields are automatically blocked by the backend due to security information, and the returned values are null:

{

   "thumbnail": "${iportalDirectoryServicesRootUrl}/../resources/thumbnail/profile/admin.png",

   "ownRoles": null,

   "joinTime": null,

   "departmentId": null,

   "roles": null,

   "description": null,

   "type": "CREATOR",

   "userGroups": null,

   "password": null,

   "extendAttrs": null,

   "expirationTime": null,

   "isLocked": false,

   "nickname": "admin",

   "name": "admin",

   "passwordQuestion": {

     "pwdAnswer": null,

     "pwdQuestion": "food"

   },

   "id": null,

   "passwordLastModified": null,

   "email": "12454586@qq.com",

   "departmentNames": 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.

See