Get User's Full Provisioning Report
/essbase/rest/v1/users/{userId}/provisionReport
Gets a full provisioning report for a specific user. Service roles are included in the response only if the logged in user has Service Administrator role. The logged in user must have at least Database Manager role for an application to get its provisioning report. Application roles are included in the report only if the logged in user has at least Application Manager role for the application.
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
-
userId(required): string
User ID.
-
expand: string
Value can be
allornone. Default value isnone, meaning only links to applications are returned. Ifallis specified, provisioning information for all applications is returned.
Response
- application/json
- application/xml
200 Response
OK
Full provisioning report including service and all the applications.
object-
inheritedFromGroups:
array inheritedFromGroups
Unique Items Required:
true -
name:
string
404 Response
Not Found
User not found.
500 Response
Internal Server Error.
Examples
The following example shows how to get a full provisioning report for a specific 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
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/users/user002/provisionReport?expand=all&links=none" -H "Accept:application/json" -u %User%:%Password%
Example of Response Body
{
"service" : {
"roles" : {
"items" : [ {
"name" : "user"
} ]
}
},
"applications" : {
"items" : [ {
"name" : "CalcTuple",
"roles" : {
"items" : [ {
"name" : "db_manager"
} ]
},
"filters" : {
"items" : [ ]
},
"scripts" : {
"items" : [ {
"database" : "Tuple",
"items" : [ {
"name" : "Access to all calculation scripts"
} ]
} ]
}
}, {
"name" : "Facility",
"roles" : {
"items" : [ {
"name" : "app_manager"
} ]
},
"filters" : {
"items" : [ ]
},
"scripts" : {
"items" : [ {
"database" : "Rating",
"items" : [ {
"name" : "Access to all calculation scripts"
} ]
} ]
}
}, {
"name" : "Sample",
"roles" : {
"items" : [ {
"name" : "db_update"
} ]
},
"filters" : {
"items" : [ {
"database" : "Basic",
"items" : [ {
"name" : "filter2"
} ]
} ]
},
"scripts" : {
"items" : [ {
"database" : "Basic",
"items" : [ {
"name" : "calc1"
} ]
} ]
}
} ]
}
}