1. REST API for Oracle Essbase
  2. Tasks
  3. Users

Search or Export Users

get

/essbase/rest/v1/users

Get a list of users based on search results, or export users as CSV file.

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

  • Value can be all or none. Default value is all, meaning service role and groups are returned for each user. If none is specified, service role and groups are not returned.

    Default Value: all

  • User ID wildcard pattern. Filter by name of user if header Accept='application/json' or Accept='application/xml'.

  • Maximum number of users to return, if header Accept='application/json' or Accept='application/xml'. Default of -1 = no maximum.

    Default Value: -1
Back to Top

Response

Supported Media Types

200 Response

OK

User results returned successfully. Response type can be either JSON, XML, or CSV stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the users are returned in the response body. If Accept='application/octet-stream', the users are returned as a JSON stream.

Body ()
Root Schema : Users
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : User
Type: object
Show Source
Nested Schema : groups
Type: array

Comma-separated list of group names associated with this user.

Show Source

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to list or export Essbase users.

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 – List Users

The following example lists up to five users.

call properties.bat
curl -X GET  -u %User%:%Password% "https://myserver.example.com:9001/essbase/rest/v1/users?filter=*&limit=5&expand=none&links=none" -H "accept: application/json"

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "id": "User001",
      "name": "User One",
      "email": "user001@example.com"
    },
    {
      "id": "User002",
      "name": "User Two",
      "email": "user002@example.com"
    },
    {
      "id": "User003",
      "name": "User Three",
      "email": "user003@example.com"
    },
    {
      "id": "User004",
      "name": "User Four",
      "email": "user004@example.com"
    },
    {
      "id": "User005",
      "name": "User Five",
      "email": "user005@example.com"
    }
  ]
}

Script with cURL Command – Export Users

The following example exports users to users.csv. 

call properties.bat
curl -X GET -u %User%:%Password% "https://myserver.example.com:9001/essbase/rest/v1/users?filter=*" -H "Accept: application/octet-stream" -o users.csv
Back to Top