User Group Report (v2)
Generates a User Group Report for users in the system.
This report lists the direct or indirect membership of users assigned to the group. You can create a query for a specific user or a group or a combination of users and groups.
The report indicates whether the user assignment to an EPM group is direct (as member of a group) or indirect (as member of a group that is a child of a nested group). The report identifies the user's login name, first name, last name, email address, assigned group, and type of assignment.
The API is synchronous and returns the outcome of the operation in the response. Any non-zero status indicates failure in generating a User Group Report.
This API is version v2.
Required Roles
-
Service Administrator
-
Any predefined role and the Access Control - Manage application role
-
Any predefined role and the Access Control - View application role
REST Resource
GET
/interop/rest/security/v2/report/usergroupreport?userlogin=<userlogin>&groupname=<groupname>
Note:
Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.
Table 12-62 Tasks for User Group Report
Task | Request | REST Resource |
---|---|---|
User Group Report | GET | /interop/rest/security/v2/report/usergroupreport?userlogin=<
userlogin>&groupname=<groupname> |
Request
Supported Media Types: application/json
The following table summarizes the request parameters.
Table 12-63 Request Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
userlogin |
Generate usergroupreport for the specified
user.
|
Query | No | The report is created for all users. |
groupname |
Generate usergroupreport for the users belonging
to the specified group name.
|
Query | No | The report is created for all groups. |
Response
Supported Media Types: application/json
Table 12-64 Response Parameters
Parameters | Description |
---|---|
links |
Detailed information about the link |
status |
Status of the operation
|
error |
Detailed information about the error |
details |
Records matching the request |
Examples of Response Body
The following show examples of the response body in JSON format.
Example 1: REST API Issued without userlogin
and
groupname
Query Parameters Completes without Errors
{
"links": {
"href": " https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport",
"action": "GET"
},
"status": 0,
"error": null,
"details": [
{
"userlogin": "Jade",
"firstname": "Jade",
"lastname": "Clark",
"email": "jade.clark@example.oracle.com",
"groups": [
{
"direct": "Yes",
"groupname": "Interactive User"
},
{
"direct": "No",
"groupname": "Strategic Planner"
}
]
},
{
"userlogin": "Jeff",
"firstname": "Jeff",
"lastname": "Clark",
"email": "jeff.clark@discard.oracle.com",
"groups": [
{
"direct": "Yes",
"groupname": "Analyst"
},
{
"direct": "No",
"groupname": "Strategic Planner"
}
]
}
]
}
Example 2: REST API Issued with userlogin
and
groupname
Query Parameters Completes without Errors
{
"links": {
"href": " https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport? userlogin=’Jade’&groupname='Interactive User'",
"action": "GET"
},
"status": 0,
"error": null,
"details": [
{
"userlogin": "Jade",
"firstname": "Jade",
"lastname": "Clark",
"email": "jade.clark@example.oracle.com",
"groups": [
{
"direct": "Yes",
"groupname": "Interactive User"
}
]
}
]
}
Example 3: REST API Issued Only with a userlogin
Query Parameter
Completes without Errors
{
"links": {
"href": " https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userlogin='Jade'",
"action": "GET"
},
"status": 0,
"error": null,
"details": [
{
"userlogin": "Jade",
"firstname": "Jade",
"lastname": "Clark",
"email": "jade.clark@example.oracle.com",
"groups": [
{
"direct": "Yes",
"groupname": "Interactive User"
},
{
"direct": "No",
"groupname": "Strategic Planner"
}
]
}
]
}
Example 4: REST API Issued Only with a groupname
Query Parameter
Completes without Errors
{
"links": {
"href": " https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?groupname='Strategic Planner'",
"action": "GET"
},
"status": 0,
"error": null,
"details": [
{
"userlogin": "Jade",
"firstname": "Jade",
"lastname": "Clark",
"email": "jade.clark@example.oracle.com",
"groups": [
{
"direct": "No",
"groupname": "Strategic Planner"
}
]
},
{
"userlogin": "Jeff",
"firstname": "Jeff",
"lastname": "Clark",
"email": "jeff.clark@example.oracle.com",
"groups": [
{
"direct": "No",
"groupname": "Strategic Planner"
}
]
}
]
}
Example 5: Job Completes with Errors
{
"links": {
"href": " https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport",
"action": "GET"
},
"status": 1,
"error": {
"errorcode": "EPMCSS-21192",
"errormessage": "Failed to generate User Group Report. Authorization failed. Please provide valid authorized user."
},
"details": null
}
Sample cURL Commands
Sample cURL command using Basic Auth
curl -X GET -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json'
'https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport'
curl -X GET -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json'
'https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userlogin=< userlogin>&groupname=<groupname>
Sample cURL command using oAuth
curl --location --request GET 'https://<BASE-URL>/interop/rest/security/v2/report
/usergroupreport' --header "Authorization: Bearer <OAUTH_TOKEN>"
curl --location --request GET 'https://<EPM-CLOUD-BASE-URL>/interop/rest/security/v2/report
/usergroupreport/?userlogin=< userlogin>&groupname=<groupname>' --header "Authorization: Bearer <OAUTH_TOKEN>"