Jump to

• Request
• Response
• Examples

Get Application Role Provisioning

get

/applications/{app}/permissions/{id}

Retrieve provisioning information for the specified application.

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

Request

Path Parameters

• app(required):

  Application name.

• id(required):

  User or group ID.

Query Parameters

• group:

  If true, ID is for a group. If false, ID is for a user. Default is false (ID is for a user.)

• inherited:

  If true, consider roles derived through parent groups. Default is false.

Back to Top

Response

200 Response

OK

Provisioning information returned successfully.

400 Response

Bad Request

The logged in user may not have the appropriate application role.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get an application's provisioning details, using cURL to call 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/essbase/rest/v1/applications/Sample/permissions/User002?group=false&inherited=true"-H  "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "id": "User002",
  "role": "db_update",
  "links": [
    {
      "rel": "get",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "PUT"
    },
    {
      "rel": "delete",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "DELETE"
    }
  ]
}

Back to Top