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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
-Count 10
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024Aggregation
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Aggregations** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional]
**Hits** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The results of the aggregation search query. | [optional]
**Hits** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional]
## Examples

2
docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Description** | **String** | The description of the saved search. | [optional]
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using 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. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]

4
docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md
View File

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee
-ApprovalStatus null `
-Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00
```

2
docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md
View File

@@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2024PendingApprov
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The approval id. | [optional]
**AccessRequestId** | **String** | This is the access request id. | [optional]
**Name** | **String** | The name of the approval. | [optional]
**Created** | **System.DateTime** | When the approval was created. | [optional]
**Modified** | **System.DateTime** | When the approval was modified last time. | [optional]
@@ -41,6 +42,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$PendingApproval = Initialize-PSSailpoint.V2024PendingApproval -Id id12345 `
-AccessRequestId 2b838de9db9babcfe646d4f274ad4238 `
-Name aName `
-Created 2017-07-11T18:45:37.098Z `
-Modified 2018-07-25T20:22:28.104Z `

2
docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false]
**AuthoritativeSource** | **String** | Source ID. | [required]
**SelectedFormats** | **[]String** | 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]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | 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** | **String** | 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** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Description** | **String** | The description of the saved search. | [optional]
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using 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. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using 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. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/Search.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**QueryType** | [**QueryType**](query-type) | | [optional]
**QueryVersion** | **String** | | [optional]
**Query** | [**Query**](query) | | [optional]

169
docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md Normal file
View File

@@ -0,0 +1,169 @@
---
id: v2024-search-document
title: SearchDocument
pagination_label: SearchDocument
sidebar_label: SearchDocument
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'V2024SearchDocument']
slug: /tools/sdk/powershell/v2024/models/search-document
tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'V2024SearchDocument']
---
# SearchDocument
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The unique ID of the referenced object. | [required]
**Name** | **String** | The human readable name of the referenced object. | [required]
**Description** | **String** | Access item's description. | [optional]
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**Type** | [**DocumentType**](document-type) | | [required]
**Source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional]
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional]
**EntitlementCount** | **Int32** | Number of entitlements included with the role. | [optional]
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional]
**Stage** | **String** | Activity's current stage. | [optional]
**Origin** | **String** | Activity's origin. | [optional]
**Status** | **String** | Identity's status in SailPoint. | [optional]
**Requester** | [**AccountSource**](account-source) | | [optional]
**Recipient** | [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | **String** | ID of the group of events. | [optional]
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | **String** | Sources involved in the account activity. | [optional]
**DisplayName** | **String** | Identity's display name. | [optional]
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
**SegmentCount** | **Int32** | Number of segments with the role. | [optional]
**CloudGoverned** | **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false]
**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
**IdentityCount** | **Int32** | Number of identities who have access to the entitlement. | [optional]
**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
**Actor** | **String** | Name of the actor that generated the event. | [optional]
**Target** | **String** | Name of the target, or recipient, of the event. | [optional]
**Stack** | **String** | The event's stack. | [optional]
**IpAddress** | **String** | Target system's IP address. | [optional]
**Details** | **String** | ID of event's details. | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional]
**Objects** | **[]String** | Objects the event is happening to. | [optional]
**Operation** | **String** | Operation, or action, performed during the event. | [optional]
**TechnicalName** | **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional]
**FirstName** | **String** | Identity's first name. | [optional]
**LastName** | **String** | Identity's last name. | [optional]
**Email** | **String** | Identity's primary email address. | [optional]
**Phone** | **String** | Identity's phone number. | [optional]
**Inactive** | **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false]
**Protected** | **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false]
**EmployeeNumber** | **String** | Identity's employee number. | [optional]
**Manager** | [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional]
**IsManager** | **Boolean** | Indicates whether the identity is a manager of other identities. | [optional]
**IdentityProfile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional]
**ProcessingState** | **String** | Identity's processing state. | [optional]
**ProcessingDetails** | [**ProcessingDetails**](processing-details) | | [optional]
**Accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional]
**AccountCount** | **Int32** | Number of accounts associated with the identity. | [optional]
**Apps** | [**[]App**](app) | List of applications the identity has access to. | [optional]
**AppCount** | **Int32** | Number of applications the identity has access to. | [optional]
**Access** | [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional]
**AccessCount** | **Int32** | Number of access items assigned to the identity. | [optional]
**RoleCount** | **Int32** | Number of roles assigned to the identity. | [optional]
**AccessProfileCount** | **Int32** | Number of access profiles included with the role. | [optional]
**Owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional]
**OwnsCount** | **Int32** | Number of access items the identity owns. | [optional]
**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchDocument = Initialize-PSSailpoint.V2024SearchDocument -Id 2c91808568c529c60168cca6f90c1313 `
-Name John Doe `
-Description The admin role `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Synced 2018-06-25T20:22:33.104Z `
-Enabled true `
-Requestable true `
-RequestCommentsRequired false `
-Owner null `
-Type null `
-Source null `
-Entitlements null `
-EntitlementCount 3 `
-Tags [TAG_1, TAG_2] `
-Action update `
-Stage Completed `
-Origin null `
-Status UNREGISTERED `
-Requester null `
-Recipient null `
-TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
-Errors null `
-Warnings null `
-Approvals null `
-OriginalRequests null `
-ExpansionItems null `
-AccountRequests null `
-Sources smartsheet-test, airtable-v4, IdentityNow `
-DisplayName Carol.Adams `
-Segments null `
-SegmentCount 1 `
-CloudGoverned false `
-Privileged false `
-IdentityCount 3 `
-Type SYSTEM_CONFIG `
-Actor System `
-Target Carol.Adams `
-Stack tpe `
-IpAddress 52.52.97.85 `
-Details 73b65dfbed1842548c207432a18c84b0 `
-Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} `
-Objects null `
-Operation REQUEST `
-TechnicalName AUTHENTICATION_REQUEST_PASSED `
-FirstName Carol `
-LastName Adams `
-Email Carol.Adams@sailpointdemo.com `
-Phone +1 440-527-3672 `
-Inactive false `
-Protected false `
-EmployeeNumber 1a2a3d4e `
-Manager null `
-IsManager false `
-IdentityProfile null `
-ProcessingState null `
-ProcessingDetails null `
-Accounts null `
-AccountCount 3 `
-Apps null `
-AppCount 2 `
-Access null `
-AccessCount 5 `
-RoleCount 1 `
-AccessProfileCount 1 `
-Owns null `
-OwnsCount 5 `
-AccessProfiles null
```
- Convert the resource to JSON
```powershell
$SearchDocument | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024S
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | 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** | **String** | 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** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
-Count 10.45
```

5
docs/tools/sdk/powershell/Reference/V2024/Models/index.md
View File

@@ -10,10 +10,9 @@ slug: /tools/sdk/powershell/v2024/models
tags: ['SDK', 'Software Development Kit', 'v2024', 'models']
---
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
## Key Features
- Attributes: Describe each attribute, including its name, data type, and whether it's required.
- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
- Example: Provides a sample of how the API uses the model.
- Example: Provides a sample of how the API uses the model.