Skip to main content

ReportDetailsArguments

The string-object map(dictionary) with the arguments needed for report processing.

Properties

NameTypeDescriptionNotes
applicationstrSource ID.[required]
source_namestrSource name.[required]
correlated_onlyboolFlag to specify if only correlated identities are included in report.[required][default to False]
authoritative_sourcestrSource ID.[required]
selected_formats[]strOutput report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default.[optional]
indices[]IndexThe names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.[optional]
querystrThe query using the Elasticsearch Query String Query syntax from the Query DSL extended by SailPoint to support Nested queries.[required]
columnsstrComma separated string consisting of technical attribute names of fields to include in report. Use access.spread, apps.spread, accounts.spread to include respective identity access details. Use accessProfiles.spread to unclude access profile details. Use entitlements.spread to include entitlement details.[optional]
sort[]strThe fields to be used to sort the search results. Use + or - to specify the sort direction.[optional]
}

Example

from sailpoint.v3.models.report_details_arguments import ReportDetailsArguments

report_details_arguments = ReportDetailsArguments(
application='2c9180897eSourceIde781782f705b9',
source_name='Active Directory',
correlated_only=True,
authoritative_source='1234sourceId5678902',
selected_formats=[CSV],
indices=[entitlements],
query='name:a*',
columns='displayName,firstName,lastName,email,created,attributes.cloudLifecycleState',
sort=[displayName, +id]
)

[Back to top]