developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Models/ReportDetailsArguments.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-report-details-arguments	ReportDetailsArguments	ReportDetailsArguments	ReportDetailsArguments	pythonsdk	python Python sdk ReportDetailsArguments V2024ReportDetailsArguments	/tools/sdk/python/v2024/models/report-details-arguments	SDK Software Development Kit ReportDetailsArguments V2024ReportDetailsArguments

ReportDetailsArguments

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

Properties

Name	Type	Description	Notes
application	str	Source ID.	[required]
source_name	str	Source name.	[required]
correlated_only	bool	Flag to specify if only correlated identities are included in report.	[required][default to False]
authoritative_source	str	Source ID.	[required]
selected_formats	[]str	Output 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	[]Index	The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.	[optional]
query	str	The query using the Elasticsearch Query String Query syntax from the Query DSL extended by SailPoint to support Nested queries.	[required]
columns	str	Comma 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	[]str	The fields to be used to sort the search results. Use + or - to specify the sort direction.	[optional]
}

Example

from sailpoint.v2024.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]