Get a named user profile
Returns login name, display name, groups, roles, and MRU member selections for a named user. Requests for another user require administrator access.
Required Roles
Service Administrator
REST Resource
GET /HyperionPlanning/rest/v3/applications/{application}/users/{username}
Request
Parameters:
Table 3-35 Request Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application
|
The name of the application. | path | Yes | None |
username
|
User login name. | path | Yes | None |
No request body is defined for this operation.
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/users/planner1
Response
Supported Media Types: application/json
Table 3-36 Response Parameters
| Name | Description |
|---|---|
name
|
The login name of the user. |
fullName
|
The display name of the user. |
groups
|
The groups to which the user belongs. |
role
|
The Planning security role assigned to the user. |
applicationRoles
|
The application roles assigned to the user. |
mru
|
The most recently used member selections for the user. |
mru.members
|
The most recently used member selections. |
mru.members.pov
|
The dimension-to-member mapping for the most recently used POV. |
mru.members.pov.Scenario
|
The member selected for the Scenario dimension. |
mru.members.pov.Entity
|
The member selected for the Entity dimension. |
links
|
Links to this resource and related operations. |
links[].rel
|
The relationship of the linked resource to this resource. |
links[].href
|
The URL of the linked resource. |
links[].action
|
The HTTP method used to access the linked resource. |
Sample Response
The following shows an example response.
{
"name": "planner1",
"fullName": "Planning User",
"groups": [
"Planners"
],
"role": "Planner",
"applicationRoles": [
"Approvals Supervisor"
],
"mru": {
"members": {
"pov": {
"Scenario": "Actual",
"Entity": "East"
}
}
},
"links": [
{
"rel": "self",
"href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision",
"action": "GET"
}
]
}