User Access Report (v1)

Generates an access report of users in the system and writes the report to the filename provided. This report can then be downloaded using the download command.

This is an asynchronous job and uses the job status URI to determine if the operation is complete.

Required Roles

  • Service Administrator

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

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

REST Resource

POST /interop/rest/v1/reports?q=%7Btype%3Aprovisionreport%2CfileName%3Aprovreport_17_Apr.csv%2Cformat%3Asimplified%2Cusertype%3Aserviceusers%7D

Table 13-80 Tasks for User Access Report

Task Request REST Resource
User Access Report POST /interop/rest/v1/reports?q=%7Btype%3Aprovisionreport%2CfileName%3Aprovreport_17_Apr.csv%2Cformat%3Asimplified%2Cusertype%3Aserviceusers%7D

Request

Supported Media Types: application/json

The following table summarizes the request parameters.

Table 13-81 Parameters

Name Description Type Required Default
fileName File where report is to be populated Query Yes None
type Type of report being generated: provisionreport Query Yes None
format The format of the csv file, classic or simplified Query No classic
usertype Wheter to generate the report only for Identity Domain Administrators, IDAdmins or ServiceUsers Query No ServiceUsers

Response

Supported Media Types: application/json

Table 13-82 Parameters

Parameters Description
details In case of errors, details are published with the error string
status See Migration Status Codes
links Detailed information about the link
href Links to API call
action The HTTP call type
rel Can be self and/or Job Status. If set to Job Status, you can use the href to get the status of the import operation
data Parameters as key value pairs passed in the request

Example of Response Body

Example 1: Job is in Progress

{
   "links": [
      {
         "rel": "self",
         "href": "https://<BASE-URL>/interop/rest/{api_version}/reports?q={type=provisionreport,fileName=provreport.csv,format=simplified,usertype=serviceusers}",
         "data": null,
         "action": "POST"
      },
      {
         "rel": "Job Status",
         "href": "https://<BASE-URL>/interop/rest/v1/reports/3180399797144693",
         "data": null,
         "action": "GET"
      }
   ],
   "status": -1,
   "details": null
}

Sample cURL Command Basic Auth

curl -X POST -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/x-www-form-urlencoded' 'https:///<BASE-URL>/interop/rest/v1/reports?q=%7Btype%3Aprovisionreport%2CfileName%3Aprovreport.csv%2Cformat%3Asimplified%2Cusertype%3Aserviceusers%7D'

Sample cURL Command OAuth 2.0

curl -X POST --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/x-www-form-urlencoded' 'https://<BASE-URL>/interop/rest/security/v1/reports?q=%7Btype%3Aprovisionreport%2CfileName%3Aprovreport.csv%2Cformat%3Asimplified%2Cusertype%3Aserviceusers%7D'