Add or Import Users
/users
Add or import user(s).
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
There are no request parameters for this operation.
Back to TopResponse
200 Response
OK
User added successfully. If Accept='application/json' or Accept='application/xml', the users are returned in the response body. If Accept='application/octet-stream', the added users are imported but not included in the response body.
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 add an Essbase user (works only for WebLogic security mode).
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
The --data option is used to pass a JSON file of body parameters providing the user information.
call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/users?links=none" -H "accept: application/json" -H "Content-Type: application/json" --data "@./userinfo.json" -u %User%:%Password%Sample JSON Payload
The input file to the cURL command (userinfo.json) has the following contents:
{
"password": "tempPa55",
"role": "user",
"email": "user001@example.com",
"id": "User001",
"name": "User One"
}Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "User001",
"name": "User One",
"email": "user001@example.com",
"role": "User"
}