REST API for Oracle Essbase

Get Essbase Roles

get

/roles

Returns the roles available in Essbase. Valid type values are application and server. If type is empty, then both application and server roles are returned.

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.

Request

Query Parameters

type:

Valid type values are application and server.

Response

200 Response

Returns roles for the specified type.

Examples

The following examples show how to search for service role provisioning information.

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

call properties.bat
curl -X GET https://myserver.example.com:9001 http://phoenix110702.dev3sub1phx.databasede3phx.oraclevcn.com:8999/essbase/rest/v1/roles -H "accept: application/json" -u %User%:%Password%

Example of Response Body

Essbase offers three kinds of service roles and four application-access permission levels.


{
  "items" : [ {
    "type" : "server",
    "roles" : [ "Service Administrator", "Power User", "User" ],
    "defaultRole" : "User"
  }, {
    "type" : "application",
    "roles" : [ "Application Manager", "Database Manager", "Database Update", "Database Access" ]
  } ]
}