LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

starting point for adding python sdk docs

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/tools/sdk/python/Reference/V3/Models/ReportDetailsArguments.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: report-details-arguments
title: ReportDetailsArguments
pagination_label: ReportDetailsArguments
sidebar_label: ReportDetailsArguments
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ReportDetailsArguments', 'ReportDetailsArguments']
slug: /tools/sdk/python/v3/models/report-details-arguments
tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'ReportDetailsArguments']
---
# 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**](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](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) 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
```python
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]](#)