mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update to powershell SDK docs: 13271083916
This commit is contained in:
developer-relations-sp
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10
|
||||
```
|
||||
|
||||
|
||||
@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR
|
||||
-ApprovalStatus null `
|
||||
-Comment approved `
|
||||
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
|
||||
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
|
||||
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
|
||||
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
|
||||
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
|
||||
-Modified 2020-03-24T11:11:41.139-05:00 `
|
||||
-Created 2020-03-24T11:11:41.139-05:00
|
||||
```
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10.45
|
||||
```
|
||||
|
||||
|
||||
@@ -388,12 +388,12 @@ Path | Index | **String** | True | The index from which to fetch the specifie
|
||||
Path | Id | **String** | True | ID of the requested document.
|
||||
|
||||
### Return type
|
||||
[**SearchDocument**](../models/search-document)
|
||||
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | The requested document. | SearchDocument
|
||||
200 | The requested document. | SystemCollectionsHashtable
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -438,12 +438,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**SearchDocument[]**](../models/search-document)
|
||||
[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of matching documents. | SearchDocument[]
|
||||
200 | List of matching documents. | SystemCollectionsHashtable[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10
|
||||
```
|
||||
|
||||
|
||||
@@ -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** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
id: v2024-index
|
||||
title: Index
|
||||
pagination_label: Index
|
||||
sidebar_label: Index
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Index', 'V2024Index']
|
||||
slug: /tools/sdk/powershell/v2024/models/index
|
||||
tags: ['SDK', 'Software Development Kit', 'Index', 'V2024Index']
|
||||
---
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `accessprofiles` (value: `"accessprofiles"`)
|
||||
|
||||
* `accountactivities` (value: `"accountactivities"`)
|
||||
|
||||
* `entitlements` (value: `"entitlements"`)
|
||||
|
||||
* `events` (value: `"events"`)
|
||||
|
||||
* `identities` (value: `"identities"`)
|
||||
|
||||
* `roles` (value: `"roles"`)
|
||||
|
||||
* `STAR` (value: `"*"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee
|
||||
-ApprovalStatus null `
|
||||
-Comment approved `
|
||||
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
|
||||
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
|
||||
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
|
||||
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
|
||||
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
|
||||
-Modified 2020-03-24T11:11:41.139-05:00 `
|
||||
-Created 2020-03-24T11:11:41.139-05:00
|
||||
```
|
||||
|
||||
@@ -1,169 +0,0 @@
|
||||
---
|
||||
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]](#)
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10.45
|
||||
```
|
||||
|
||||
|
||||
@@ -388,12 +388,12 @@ Path | Index | **String** | True | The index from which to fetch the specifie
|
||||
Path | Id | **String** | True | ID of the requested document.
|
||||
|
||||
### Return type
|
||||
[**SearchDocument**](../models/search-document)
|
||||
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | The requested document. | SearchDocument
|
||||
200 | The requested document. | SystemCollectionsHashtable
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -438,12 +438,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**SearchDocument[]**](../models/search-document)
|
||||
[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of matching documents. | SearchDocument[]
|
||||
200 | List of matching documents. | SystemCollectionsHashtable[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10
|
||||
```
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResul
|
||||
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** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
id: index
|
||||
title: Index
|
||||
pagination_label: Index
|
||||
sidebar_label: Index
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Index', 'Index']
|
||||
slug: /tools/sdk/powershell/v3/models/index
|
||||
tags: ['SDK', 'Software Development Kit', 'Index', 'Index']
|
||||
---
|
||||
|
||||
|
||||
# Index
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `accessprofiles` (value: `"accessprofiles"`)
|
||||
|
||||
* `accountactivities` (value: `"accountactivities"`)
|
||||
|
||||
* `entitlements` (value: `"entitlements"`)
|
||||
|
||||
* `events` (value: `"events"`)
|
||||
|
||||
* `identities` (value: `"identities"`)
|
||||
|
||||
* `roles` (value: `"roles"`)
|
||||
|
||||
* `STAR` (value: `"*"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq
|
||||
-ApprovalStatus null `
|
||||
-Comment approved `
|
||||
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
|
||||
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
|
||||
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
|
||||
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
|
||||
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
|
||||
-Modified 2020-03-24T11:11:41.139-05:00 `
|
||||
-Created 2020-03-24T11:11:41.139-05:00
|
||||
```
|
||||
|
||||
@@ -1,169 +0,0 @@
|
||||
---
|
||||
id: search-document
|
||||
title: SearchDocument
|
||||
pagination_label: SearchDocument
|
||||
sidebar_label: SearchDocument
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'SearchDocument']
|
||||
slug: /tools/sdk/powershell/v3/models/search-document
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'SearchDocument']
|
||||
---
|
||||
|
||||
|
||||
# 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** | [**[]Approval**](approval) | 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.V3SearchDocument -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]](#)
|
||||
|
||||
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
|
||||
$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
|
||||
-Count 10.45
|
||||
```
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user