User Group Reports

Generates User Group Reports for users in the system and identifies direct and indirect group memberships within Access Control and groups.

These reports identify whether a user's assignment to a group is direct (as a direct member of a group) or indirect (through membership in a child group within a nested group hierarchy). The reports include details such as user login name, first name, last name, email address, assigned group, and assignment type.

The v1 API generates the report and writes it to the specified output file, which can be downloaded using the Download API. The report format is identical to the CSV version generated from the User Group Report tab in Access Control. The v1 API is asynchronous and returns a Job ID that can be used to monitor report generation status.

The v2 API generates the report directly through the request and supports querying by specific user login, group name, or user attributes such as first name, last name, user login, and email in any combination. This topic describes the simplified v2 version of the REST API. This version contains all parameters in the payload and does not require URL encoding while calling the REST APIs, which makes the v2 API easier to use. The v2 API is synchronous and returns the outcome of the operation directly in the response.

Any non-zero status value indicates failure in generating the User Group Report.

Required Roles

• Service Administrator

• Any application role and the Access Control - Manage granular role

• Any application role and the Access Control - View granular role