mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 04:19:34 +00:00
Update to powershell SDK docs: 13183223237
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: v2024-data-segment
|
||||
title: DataSegment
|
||||
pagination_label: DataSegment
|
||||
sidebar_label: DataSegment
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DataSegment', 'V2024DataSegment']
|
||||
slug: /tools/sdk/powershell/v2024/models/data-segment
|
||||
tags: ['SDK', 'Software Development Kit', 'DataSegment', 'V2024DataSegment']
|
||||
---
|
||||
|
||||
|
||||
# DataSegment
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The segment's ID. | [optional]
|
||||
**Name** | **String** | The segment's business name. | [optional]
|
||||
**Created** | **System.DateTime** | The time when the segment is created. | [optional]
|
||||
**Modified** | **System.DateTime** | The time when the segment is modified. | [optional]
|
||||
**Description** | **String** | The segment's optional description. | [optional]
|
||||
**Scopes** | [**[]Scope**](scope) | List of Scopes that are assigned to the segment | [optional]
|
||||
**MemberSelection** | [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional]
|
||||
**MemberFilter** | [**VisibilityCriteria**](visibility-criteria) | | [optional]
|
||||
**Membership** | [**MembershipType**](membership-type) | | [optional]
|
||||
**Enabled** | **Boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to $false]
|
||||
**Published** | **Boolean** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$DataSegment = Initialize-PSSailpoint.V2024DataSegment -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
|
||||
-Name segment-xyz `
|
||||
-Created 2020-01-01T00:00Z `
|
||||
-Modified 2020-01-01T00:00Z `
|
||||
-Description This segment represents xyz `
|
||||
-Scopes [{scope=ENTITLEMENT, visibility=SELECTION, scopeFilter=null, scopeSelection=[{type=ENTITLEMENT, id=34d73f611449463ea4fdcf02cda0c397}]}] `
|
||||
-MemberSelection [{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}] `
|
||||
-MemberFilter null `
|
||||
-Membership null `
|
||||
-Enabled true `
|
||||
-Published true
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$DataSegment | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
id: v2024-membership-type
|
||||
title: MembershipType
|
||||
pagination_label: MembershipType
|
||||
sidebar_label: MembershipType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'MembershipType', 'V2024MembershipType']
|
||||
slug: /tools/sdk/powershell/v2024/models/membership-type
|
||||
tags: ['SDK', 'Software Development Kit', 'MembershipType', 'V2024MembershipType']
|
||||
---
|
||||
|
||||
|
||||
# MembershipType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `ALL` (value: `"ALL"`)
|
||||
|
||||
* `FILTER` (value: `"FILTER"`)
|
||||
|
||||
* `SELECTION` (value: `"SELECTION"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
37
docs/tools/sdk/powershell/Reference/V2024/Models/Ref.md
Normal file
37
docs/tools/sdk/powershell/Reference/V2024/Models/Ref.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-ref
|
||||
title: Ref
|
||||
pagination_label: Ref
|
||||
sidebar_label: Ref
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Ref', 'V2024Ref']
|
||||
slug: /tools/sdk/powershell/v2024/models/ref
|
||||
tags: ['SDK', 'Software Development Kit', 'Ref', 'V2024Ref']
|
||||
---
|
||||
|
||||
|
||||
# Ref
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Ref = Initialize-PSSailpoint.V2024Ref -Type null `
|
||||
-Id 2c91808568c529c60168cca6f90c1313
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Ref | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
41
docs/tools/sdk/powershell/Reference/V2024/Models/Scope.md
Normal file
41
docs/tools/sdk/powershell/Reference/V2024/Models/Scope.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-scope
|
||||
title: Scope
|
||||
pagination_label: Scope
|
||||
sidebar_label: Scope
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Scope', 'V2024Scope']
|
||||
slug: /tools/sdk/powershell/v2024/models/scope
|
||||
tags: ['SDK', 'Software Development Kit', 'Scope', 'V2024Scope']
|
||||
---
|
||||
|
||||
|
||||
# Scope
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Scope** | [**ScopeType**](scope-type) | | [optional]
|
||||
**Visibility** | [**ScopeVisibilityType**](scope-visibility-type) | | [optional]
|
||||
**ScopeFilter** | [**VisibilityCriteria**](visibility-criteria) | | [optional]
|
||||
**ScopeSelection** | [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Scope = Initialize-PSSailpoint.V2024Scope -Scope null `
|
||||
-Visibility null `
|
||||
-ScopeFilter null `
|
||||
-ScopeSelection [{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Scope | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
id: v2024-scope-type
|
||||
title: ScopeType
|
||||
pagination_label: ScopeType
|
||||
sidebar_label: ScopeType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScopeType', 'V2024ScopeType']
|
||||
slug: /tools/sdk/powershell/v2024/models/scope-type
|
||||
tags: ['SDK', 'Software Development Kit', 'ScopeType', 'V2024ScopeType']
|
||||
---
|
||||
|
||||
|
||||
# ScopeType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `ENTITLEMENT` (value: `"ENTITLEMENT"`)
|
||||
|
||||
* `CERTIFICATION` (value: `"CERTIFICATION"`)
|
||||
|
||||
* `IDENTITY` (value: `"IDENTITY"`)
|
||||
|
||||
* `ENTITLEMENTREQUEST` (value: `"ENTITLEMENTREQUEST"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
id: v2024-scope-visibility-type
|
||||
title: ScopeVisibilityType
|
||||
pagination_label: ScopeVisibilityType
|
||||
sidebar_label: ScopeVisibilityType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ScopeVisibilityType', 'V2024ScopeVisibilityType']
|
||||
slug: /tools/sdk/powershell/v2024/models/scope-visibility-type
|
||||
tags: ['SDK', 'Software Development Kit', 'ScopeVisibilityType', 'V2024ScopeVisibilityType']
|
||||
---
|
||||
|
||||
|
||||
# ScopeVisibilityType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `ALL` (value: `"ALL"`)
|
||||
|
||||
* `FILTER` (value: `"FILTER"`)
|
||||
|
||||
* `SELECTION` (value: `"SELECTION"`)
|
||||
|
||||
* `UNSEGMENTED` (value: `"UNSEGMENTED"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user