1. REST API for Oracle Essbase
  2. Tasks
  3. Service Role Provisioning

Get Service Role Provision

get

/essbase/rest/v1/permissions/{id}

Gets Essbase service role provisioning information. Service roles include Service Administrator, Power User, and User.

If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.

See Also: Get Application Role Provision.

Request

Path Parameters
Query Parameters

  • If true, ID is for a group. If false, ID is for a user. Default is false (ID is considered to be for a user.)

    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

OK

Provisioning information returned successfully.

Body ()
Root Schema : permission
Type: object
Show Source

400 Response

Bad Request

The logged in user may not have the required service administrator role.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to retrieve information about an Essbase user's or group's provisioned service role.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command - User Info

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/permissions/user2?links=none" -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

{
  "id" : "user2",
  "role" : "user"
}

Script with cURL Command - Group Info

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/permissions/powergroup?group=true&links=none" -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

{
  "id" : "powergroup",
  "group" : true,
  "role" : "power_user"
}
Back to Top