Update User
/users/{id}
Updates a 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
-
id(required):
ID of user.
Response
200 Response
OK
User updated successfully.
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 update an Essbase user.
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
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/users/jenp" -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 has the following contents:
{
"role": "Power User",
"email": "jen.x.power@example.com",
"id": "jenp",
"name": "Jen Power"
}Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "jenp",
"name": "Jen Power",
"email": "jen.x.power@example.com",
"role": "Power User",
"links": [
{
"rel": "get",
"href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp",
"method": "GET"
},
{
"rel": "edit",
"href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp",
"method": "PUT"
},
{
"rel": "delete",
"href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp",
"method": "DELETE"
},
{
"rel": "provisionReport",
"href": "https://myserver.example.com:9001/essbase/rest/v1/users/jenp/provisionReport",
"method": "GET"
}
]
}