Create report of MFA-enabled devices - results in file
POST {{apiPath}}/environments/{{envID}}/dataExplorations
This example uses the dataExplorations
endpoint to create a report of all MFA-enabled devices.
In the body of the request, deliverAs
is set to ASYNC_FILE
so that the results will be provided as a file.
Note: The dataExplorationTemplateID
has a static value of db632bfd-7054-4bde-b108-a384aac2d513
.
See Reporting for more information, including the complete data model.
MFA reports data model
Property | Type | Required? |
---|---|---|
dataExplorationTemplate.id | String | Required |
deliverAs | String | Optional |
fields\[\] | Array | Optional |
filter | String | Optional |
sync | String | Optional |
The response contains a status
field. The value of this field will be IN_PROGRESS until the generation of the report has been completed.
After running this request, poll with the request
GET {{apiPath}}/environments/{{envID}}/dataExplorations/{{dataExplorationID}}/
,
using the ID that was returned when you created the report, until the status
field in the response equals SUCCESS
.
Request Body
{"dataExplorationTemplate"=>{"id"=>"{{dataExplorationTemplateID}}"}, "fields"=>[{"name"=>"userId"}, {"name"=>"username"}, {"name"=>"phone"}, {"name"=>"deviceStatus"}, {"name"=>"deviceId"}], "filter"=>"(mfaEnabled eq \"true\")", "deliverAs"=>"ASYNC_FILE"}