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

Update to powershell SDK docs: 13183223237

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-06 16:21:30 +00:00
parent 28a78af800
commit bce7a2a2be
13 changed files with 810 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md
View File

@@ -15,7 +15,7 @@ With this functionality in place, users can read authentication profiles and mak
An authentication profile represents an identity profile's authentication configuration. An authentication profile represents an identity profile's authentication configuration.
When the identity profile is created, its authentication profile is also created. When the identity profile is created, its authentication profile is also created.
An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies.

2
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md
View File

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'BetaManagedClients'
# ManagedClients # ManagedClients
Use this API to implement managed client functionality. Use this API to implement managed client functionality.
With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations.

2
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md
View File

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'BetaManagedCluster
# ManagedClusters # ManagedClusters
Use this API to implement managed cluster functionality. Use this API to implement managed cluster functionality.
With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones.

2
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md
View File

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig']
# OrgConfig # OrgConfig
Use this API to implement organization configuration functionality. Use this API to implement organization configuration functionality.
Administrators can use this functionality to manage organization settings, such as time zones. Administrators can use this functionality to manage organization settings, such as time zones.

2
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md
View File

@@ -12,7 +12,7 @@ tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'Be
# SuggestedEntitlementDescription # SuggestedEntitlementDescription
Use this API to implement Suggested Entitlement Description (SED) functionality. Use this API to implement Suggested Entitlement Description (SED) functionality.
SED functionality leverages the power of LLM to generate suggested entitlement descriptions. SED functionality leverages the power of LLM to generate suggested entitlement descriptions.
Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC).

413
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md Normal file
View File

@@ -0,0 +1,413 @@
---
id: v2024-data-segmentation
title: DataSegmentation
pagination_label: DataSegmentation
sidebar_label: DataSegmentation
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'DataSegmentation', 'V2024DataSegmentation']
slug: /tools/sdk/powershell/v2024/methods/data-segmentation
tags: ['SDK', 'Software Development Kit', 'DataSegmentation', 'V2024DataSegmentation']
---
# DataSegmentation
This service is responsible for creating segments that will determine how access is delegated to identities
withing the organization.
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create Segment
[**Remove-V2024DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete Segment by ID
[**Get-V2024DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get Segment by ID
[**Get-V2024DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID
[**Get-V2024DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity
[**Get-V2024DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get Segments
[**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment
[**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID
## create-data-segment
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | DataSegment | [**DataSegment**](../models/data-segment) | True |
### Return type
[**DataSegment**](../models/data-segment)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
201 | Segment created | DataSegment
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
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$DataSegment = @""@
# Create Segment
try {
$Result = ConvertFrom-JsonToDataSegment -Json $DataSegment
New-V2024DataSegment -V2024DataSegment $Result
# Below is a request that includes all optional parameters
# New-V2024DataSegment -V2024DataSegment $DataSegment
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-data-segment
This API deletes the segment specified by the given ID.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The segment ID to delete.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Published | **Boolean** | (optional) (default to $false) | This determines which version of the segment to delete
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
204 | No content. |
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false)
# Delete Segment by ID
try {
Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Published $Published
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-data-segment
This API returns the segment specified by the given ID.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The segment ID to retrieve.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**DataSegment**](../models/data-segment)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Segment | DataSegment
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Segment by ID
try {
Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-data-segment-identity-membership
This API returns the segment membership specified by the given identity ID.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityId | **String** | True | The identity ID to retrieve the segments they are in.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Segment Memberships for specified identity | 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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get SegmentMembership by Identity ID
try {
Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-data-segmentation-enabled-for-user
This API returns whether or not segmentation is enabled for the identity.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | IdentityId | **String** | True | The identity ID to retrieve if segmentation is enabled for the identity.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
**Boolean**
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Returns if segmentation is enabled for a specified User | Boolean
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Is Segmentation enabled by Identity
try {
Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-data-segments
This API returns the segment specified by the given ID.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Enabled | **Boolean** | (optional) (default to $true) | This boolean indicates whether the segment is currently active. Inactive segments have no effect.
Query | Unique | **Boolean** | (optional) (default to $false) | This returns only one record if set to true and that would be the published record if exists.
Query | Published | **Boolean** | (optional) (default to $true) | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw*
### Return type
[**DataSegment[]**](../models/data-segment)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of all segments | DataSegment[]
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true)
$Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false)
$Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. (optional) (default to $false)
$Filters = 'name eq ""' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional)
# Get Segments
try {
Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental -V2024Enabled $Enabled -V2024Unique $Unique -V2024Published $Published -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-data-segment
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The segment ID to modify.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled
### Return type
[**DataSegment**](../models/data-segment)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | DataSegment
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled
$RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled
# Update Segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## publish-data-segment
This will publish the segment so that it starts applying the segmentation to the desired users if enabled
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | RequestBody | **[]String** | True | A list of segment ids that you wish to publish
Query | PublishAll | **Boolean** | (optional) (default to $true) | This flag decides whether you want to publish all unpublished or a list of specific segment ids
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Segments published |
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
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish
$RequestBody = @""@ # String[] | A list of segment ids that you wish to publish
$PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true)
# Publish segment by ID
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
# Below is a request that includes all optional parameters
# Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024PublishAll $PublishAll
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

55
docs/tools/sdk/powershell/Reference/V2024/Models/DataSegment.md Normal file
View File

@@ -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]](#)

26
docs/tools/sdk/powershell/Reference/V2024/Models/MembershipType.md Normal file
View File

@@ -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
View 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
View 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]](#)

28
docs/tools/sdk/powershell/Reference/V2024/Models/ScopeType.md Normal file
View File

@@ -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]](#)

28
docs/tools/sdk/powershell/Reference/V2024/Models/ScopeVisibilityType.md Normal file
View File

@@ -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]](#)

177
static/code-examples/v2024/code_examples_overlay.yaml
View File

@@ -4642,6 +4642,183 @@
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
} }
- path: /data-segments
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#create-data-segment
source: |
$DataSegment = @"
"@
# Create Segment
try {
$Result = ConvertFrom-JsonToDataSegment -Json $DataSegment
New-V2024DataSegment-V2024DataSegment $Result
# Below is a request that includes all optional parameters
# New-V2024DataSegment -V2024DataSegment $DataSegment
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#delete-data-segment
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false)
# Delete Segment by ID
try {
Remove-V2024DataSegment-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Published $Published
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get Segment by ID
try {
Get-V2024DataSegment-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/membership/{identityId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment-identity-membership
source: |
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get SegmentMembership by Identity ID
try {
Get-V2024DataSegmentIdentityMembership-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership"
Write-Host $_.ErrorDetails
}
- path: /data-segments/user-enabled/{identityId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user
source: |
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Is Segmentation enabled by Identity
try {
Get-V2024DataSegmentationEnabledForUser-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser"
Write-Host $_.ErrorDetails
}
- path: /data-segments
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#list-data-segments
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true)
$Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false)
$Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to $true)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. (optional) (default to $false)
$Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional)
# Get Segments
try {
Get-V2024DataSegments-V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental -V2024Enabled $Enabled -V2024Unique $Unique -V2024Published $Published -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#patch-data-segment
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled
$RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@
# Update Segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024DataSegment-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#publish-data-segment
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish
$RequestBody = @""@
$PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true)
# Publish segment by ID
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Publish-V2024DataSegment-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
# Below is a request that includes all optional parameters
# Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024PublishAll $PublishAll
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /roles/{roleId}/dimensions - path: /roles/{roleId}/dimensions
method: POST method: POST
xCodeSample: xCodeSample: