Search or Export Users
/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
-
expand(optional): string
Value can be
allornone. Default value isall, meaning service role and groups are returned for each user. Ifnoneis specified, service role and groups are not returned.Default Value:all -
filter(optional): string
User ID wildcard pattern. Filter by name of user if header
Accept='application/json'orAccept='application/xml'. -
limit(optional): integer(int32)
Maximum number of users to return, if header
Accept='application/json'orAccept='application/xml'. Default of-1= no maximum.Default Value:-1
Response
- application/json
- application/xml
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.
object-
email(optional):
string
-
groups(optional):
array groups
Comma-separated list of group names associated with this user.
-
id(optional):
string
The user ID.
-
links(optional):
array links
-
name(optional):
string
The user name. Limit 256 characters. The following special characters are not permitted:
; , = + * ? [ ] | < > \ " ' / Space Tab. Additionally, a period (.) is not permitted in group names. -
password(optional):
string
Password for the user.
-
role(optional):
string
The user role. Valid roles: User, Power User, and Service Administrator.
-
token(optional):
string
arrayComma-separated list of group names associated with this user.
400 Response
Bad Request
The logged in user may not have the appropriate service role.
500 Response
Internal Server Error.
Examples
The following example shows how to get a list of 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
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/users?filter=*&limit=5&expand=none&links=none" -H "accept: application/json" -u %User%:%Password%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"
}
]
}