User Access Report (v2)
This is an asynchronous job and uses the job status URI to determine if the operation is complete.
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
POST /interop/rest/v2/reports/useraccess
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-68 Tasks for User Access Report
Task | Request | REST Resource |
---|---|---|
User Access Report | POST |
|
Request
Supported Media Types: application/json
The following table summarizes the request parameters.
Table 12-69 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
fileName |
File where report is to be populated | Payload | Yes | None |
format |
The format of the csv file,
classic or simplified |
Payload | No | classic |
usertype |
Wheter to generate the report only for Identity Domain
Administrators, IDAdmins or
ServiceUsers |
Payload | No | ServiceUsers |
Example URL and Payload
https://<BASE-URL>/interop/rest/v2/reports/useraccess
{
"fileName": "provisionreport.csv",
"parameters": {
"format": "simplified",
"usertype": "IDAdmins"
}
}
Response
Supported Media Types: application/json
Table 12-70 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 |
null |
Example of Response Body
The following example show the contents of the response body in JSON format.
{
"details": null,
"status": -1,
"links": [
{
"href": "https://<BASE-URL>/interop/rest/v2/reports/useraccess",
"action": "POST",
"rel": "self",
"data": null
},
{
"href": "https://<BASE-URL>/interop/rest/v2/status/jobs/22747066997747363",
"action": "GET",
"rel": "Job Status",
"data": null
}
]
}
Sample cURL command
curl -X POST -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d
'{"fileName":"provisionreport.csv","parameters":{"format":"simplified","usertype":"IDAdmins"}}
' 'https://<BASE-URL>/interop/rest/v2/reports/useraccess'