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 login, a group name, or a user attribute (first name, last name, user login, email) in any combination.

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>&userattribute=<search user attributes>

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for Cloud EPM REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Table 12-68 Tasks for User Group Report

Task Request REST Resource
User Group Report GET /interop/rest/security/v2/report/usergroupreport?userlogin=< userlogin>&groupname=<groupname>&userattribute=<search user attributes>

Request

Supported Media Types: application/json

The following table summarizes the request parameters.

Table 12-69 Request Parameters

Name Description Type Required Default
userlogin Generate usergroupreport for the specified user. Query No All Users
groupname Generate usergroupreport for the users belonging to the specified group name. Query No All Users
userattribute

Generates usergroupreport for the users matching the specified user attribute (case-insensitive) with any one of these user attributes:

  • userlogin
  • firstname
  • lastname
  • email
 Query No All Users

Response

Supported Media Types: application/json

Table 12-70 Response Parameters

Parameters Description
links Detailed information about the link
status Status of the operation
  • 0: Operation succeeded
  • 1: Operation failed
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 Any 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 with userattribute and groupname Query Parameters Completes without Errors

{
  "links": {
    "href": "https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userattribute=’Doe’&groupname=’Super User’",
    "action": "GET"
  },
  "status": 0,
  "error": null,
  "details": [
 {
      "userlogin": "Jeffrey",
      "firstname": "Jeffrey",
      "lastname": "Doe",
      "email": "jeffrey.doe@example.oracle.com",
      "groups": [
        {
          "direct": "Yes",
          "groupname": "Super User""
        }
      ]
    }
  ]
}

Example 4: 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 5: 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 6: REST API Issued Only with userattribute Query Parameter Completes without Errors

{
  "links": {
    "href": " https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userattribute='Doe'",
    "action": "GET"
  },
  "status": 0,
  "error": null,
  "details": [
    {
      "userlogin": "Jeff",
      "firstname": "Jeff",
      "lastname": "Doe",
      "email": "jeff.doe@example.oracle.com",
      "groups": [
        {
          "direct": "Yes",
          "groupname": "Analyst"
        }
      ]
    },
 {
      "userlogin": "Jeffrey",
      "firstname": "Jeffrey",
      "lastname": "Doe",
      "email": "jeffrey.doe@example.oracle.com",
      "groups": [
        {
          "direct": "Yes",
          "groupname": "Super User"
        }
      ]
    },
 {
      "userlogin": "johndoe",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john.doe@example.oracle.com",
      "groups": [
        {
          "direct": "Yes",
          "groupname": "Super User"
        }
      ]
    }
  ]
}

Example 7: REST API 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 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=john@example.com&groupname=Strategic%20Planner'
curl -X GET -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json' 'https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userattribute=John&groupname=Strategic%20Planner

Sample cURL Commands OAuth 2.0

curl -X GET --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/json' 'https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport'
curl -X GET --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/json' 'https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userlogin=john@example.com&groupname=Strategic%20Planner'
curl -X GET --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/json' 'https://<BASE-URL>/interop/rest/security/v2/report/usergroupreport?userattribute=John&groupname=Strategic%20Planner'