Generates a report asynchronously for a specified tenant into a CSV file.

This API submits a request to download a CSV file and returns the job ID of the request.
The API, GET /reporting/v1.0/reporting/jobs/{id}, returns the status and other details of a downloaded job if you choose Response Content Type as application/json. If your Response Content Type is application/csv, this API uses the job ID to get the CSV file.

Entitlements required: manage reports.

Search operators supported:

eqThe attribute and operator values must be identical for a match.
swThe entire operator value must be a substring of the attribute value, starting at the beginning of the attribute value.
ewThe entire operator value must be a substring of the attribute value, matching at the end of the attribute value.
gtIf the attribute value is greater than the operator value, a match occurs. The actual comparison depends on the attribute type.
geIf the attribute value is greater than or equal to the operator value, a match occurs. The actual comparison depends on the attribute type.
ltIf the attribute value is less than the operator value, a match occurs. The actual comparison depends on the attribute type.
leIf the attribute value is less than or equal to the operator value, a match occurs. The actual comparison depends on the attribute type.


Example queries:
User List
{
User Count
{
Note: If no filter is given then the entire user registry is returned.

Query Params
string
required

Report Type.

string
required

Name of the report. Concatenate report name using either "_" or "-". E.g. "sample_report_name". The report name should be no longer than 210 characters in length.

string

Description of the report.

string

Comma separated list of user emails that will be notified of the report status.

string
required

Email of user that requested the report.

Body Params

The columns in the report and the optional filter query.

string

The SCIM compliant search filter. For example, "((emails sw \"example\") or (active eq \"true\"))"

array of objects
required

The list of columns that are used when populating the corresponding CSV file.

columns*
Responses

429

Too many Requests.

Language
URL
Choose an example:
application/json