Generate User Details Report for Account Reconciliation
Generates a User Details report for Account Reconciliation. The User Details report contains information on the users who have predefined roles in the environment and lists attributes of each user (such as name and email), their status, teams, predefined roles, workflow roles, organizations, groups, and last login timestamps.
You can use the Download REST API to download the report after generating it.
REST Resource
POST /arm/rest/fcmapi/{api_version}/rc/export/users
A sample Account Reconciliation Access Control report:
Required Roles
Service Administrator, Access Control - Manage, or Access Control - View
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request.
Table 14-5 REPORT
Name | Description | Path | Required |
---|---|---|---|
api_version |
Version of the API you are working with. This release is v1 | Yes | Yes |
fileName |
The name of the report to be generated. |
No | Yes |
format |
The format of the report (CSV or XLS). | No | No (default = CSV) |
Note:
For details about retrieving job status while running reports, see Retrieve Job Status for a Report.
Examples of request body
Example 1
{
"fileName":"UserDetails.csv",
"format":"CSV"
}
Example 2
{
"fileName":"UserDetails.csv"
}
Example 3
{
"fileName":"UserDetails.xls",
"format":"xls"
}
Response
Supported Media Types: application/json
Parameters:
Table 14-6 Parameters
Name | 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 the API call |
action |
The HTTP call type |
rel |
Relationship type can be (self , or Job Status ). If
set to Job Status , you can use the href to get the status
of the operation
|
Examples of Response Body
The following is an example of the response body in JSON format for an Account Reconciliation User Details report completed successfully:
Job Response
{
"links": [
{
"rel": "self",
"href": "https:<BASE-URL>/arm/rest/fcmapi/v1/rc/export/users",
"action": "POST"
},
{
"rel": "Job Status",
"href": "https:<BASE-URL>/arm/rest/fcmapi/v1/rc/job/42233",
"action": "GET"
}
],
"details": "In Process",
"status": -1,
"type": "rc",
"link": {},
"error": null,
"items": []
}
Job Status Response
{
"links": [
{
"rel": "self",
"href": "https:<BASE-URL>/arm/rest/fcmapi/v1/rc/job/42233",
"action": "GET"
},
{
"rel": "report-content",
"href": "https:<BASE-URL>/interop/rest/11.1.2.3.600/applicationsnapshots/UserDetails.csv/contents",
"action": "GET"
}
],
"details": "File UserDetails.csv generated successfully.",
"status": 0,
"type": "rc",
"link": null,
"error": null,
"items": null
}