URI
<portal_uri>/config/userprofile[.<format>]
Supported methods
Parent resource
Introduction
The user-level configuration information resource. By sending a GET request to the userProfile resource, you can query the user-level configuration information of the current user. User-level configuration includes username, nickname, user type, user roles, user permissions, WebApps with edit access, etc.
Supported methods:
- GET:Queries the user-level configuration information of the current user.
- HEAD: Checks whether the userProfile resource exists or whether the permission can access the userProfile resource.
Supported output formats:RJSON,JSON,XML.
Resource hierarchy
HTTP request methods
Perform an HTTP request on the following URI, using rjson output format as an example, where supermapiportal is the server name.
http://supermapiportal:8190/iportal/web/config/userprofile.rjson
GET request
Queries the user-level configuration information of the current user.
Request parameters
If no parameters are set, all user-level configuration information of the current user is returned. After setting parameters, the specified configuration information is returned. Request parameters must be included in the URI.
| Name | Type | Description |
| scope | String[] | Specifies the user-level configuration items to query. |
Response structure
Performing a GET request on the userProfile resource returns the user-level configuration information of the current user. If specific items are specified in the URI when sending the GET request, only the specified configuration items are returned. The user-level configuration consists of the following fields:
| Field | Type | Description |
| userName | String | The username. |
| nickName | String | The user's nickname. |
| type | String | The user type, including two categories: creator "CREATOR" and viewer "VIEWER". |
| theme | String | The preferred theme set by the user. Uses the administrator-configured default theme by default. |
| roles | String[] | The roles assigned to the user. |
| modulePermissions | String[] | The permissions the user has. |
| editableWebApps | String[] | The WebApps the user has access to. |
Response example
Performing a GET request on the userProfile resource: http://localhostl:8190/iportal/web/config/userprofile.rjson . The rjson format resource representation is as follows:
{
"editableWebApps": [
"DATAVIZ",
"DATAINSIGHTS",
"EARTH",
"MAPDASHBOARD"
],
"nickName": "user",
"modulePermissions": [
"portal:user:viewDashboards",
"portal:user:viewNotebooks",
"portal:user:createUpdateDeleteDashboards",
"portal:user:viewScenes",
"portal:user:uploadUpdateDeleteData",
"portal:user:publishServices",
"portal:user:viewMaps",
"portal:user:batchAddScenes",
"portal:creator:generalPrivilege",
"portal:user:createUpdateDeleteApps",
"portal:user:createUpdateDeleteGroups",
"portal:user:applyForAccessToResources",
"portal:user:addUpdateDeleteServices",
"portal:user:shareMaps",
"portal:user:viewGroups",
"portal:user:viewData",
"portal:user:batchAddMaps",
"portal:user:viewServices",
"portal:user:joinGroup",
"portal:user:viewApps",
"portal:user:shareScenes",
"portal:user:createUpdateDeleteScenes",
"portal:user:viewInsights",
"portal:user:createUpdateDeleteInsights",
"portal:user:createUpdateDeleteNotebooks",
"portal:user:shareDashboards",
"portal:user:generalPrivilege",
"portal:user:shareData",
"portal:user:shareInsights",
"portal:user:shareApps",
"portal:viewer:generalPrivilege",
"portal:user:createUpdateDeleteMaps",
"portal:user:shareServices",
"portal:user:shareNotebooks"
],
"roles": [
"DATA_CENTER",
"PORTAL_USER"
],
"theme": "ThemeSetting_blue",
"userName": "user",
"type": "CREATOR",
"version": "1.0.0"
}
HEAD request
Returns the same HTTP response headers as a GET request, but without the response entity. Metadata information contained in the response headers can be obtained without transferring the entire response content. Metadata includes media type, character encoding, content encoding, and content length.
HEAD requests can be used to determine whether the userProfile resource exists or whether the client has permission to access the userProfile resource. By performing a HEAD request on a URI with .<format>, you can also quickly determine whether the userProfile resource supports the <format> format representation.