REST API for Oracle Essbase

Search Service Role Provisioning

get

/essbase/rest/v1/permissions

Search for 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.

Request

Query Parameters

filter: string

Search filter. Values available: all/group/user. Default value is all, so if this query parameter is not specified, then all users and groups having some role will be returned.

Default Value: all
id: string

User or group ID wildcard pattern. if specified, returns users and groups matching the pattern, if not specified, returns all the users and groups having some role. Users or groups having no role are not returned.

Default Value: *
role: string

Input may include all, none, or a comma-separated list of roles (for example, service_administrator, power_user, or user). Default value is all, so if this query parameter is not specified, all users and groups having some role are returned. If none is specified, only users and groups having no role will be returned. If named roles are specified, then only users and groups having any of the named roles are returned.

Default Value: all

Response

Supported Media Types

application/json
application/xml

200 Response

User and group provisioning results returned successfully.

Root Schema : result

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupProvisionInfo"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object permission

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserGroupProvisionInfo"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : permission

Type: object

Show Source

group: boolean

true or false. Whether the id refers to a group.
id: string

User or group ID.
links: array links
name: string

User or group name.
role: string

User or group role.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

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.

Specify links=none as a query parameter if you don't want links in the response.

Script with cURL Command

The example searches for all users and groups that have power_user role provisioned.

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

Example of Response Body

Three users and one group have power_user role.

{
  "items" : [ {
    "id" : "power3",
    "role" : "power_user"
  }, {
    "id" : "power1",
    "role" : "power_user"
  }, {
    "id" : "power2",
    "role" : "power_user"
  }, {
    "id" : "powergroup",
    "group" : true,
    "role" : "power_user"
  } ]
}