POST

Run Report in Background

Use this API to run a given report in the background and return its results in CSV format to a specified email address.

Resource URL

https://<subdomain>.onelogin.com/api/2/reports/:id/run_background

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All, Read All, Read Users.

Resource Parameter

id

required

integer

Set to the id of the report that you want to run. If you don't know the report's id, use the List Reports API call to return all reports and their id values.

Request Parameters

email

required

stringA valid email address where you would like the report delivered.

Sample Request Body

{
  "email":"user@example.com",
  }

Postman Collection

Run In Postman