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

Update PowerShell SDK docs: 15141274669

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md
View File

@@ -34,11 +34,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-Segment**](#create-segment) | **POST** `/segments` | Create Segment
[**Remove-Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID
[**Get-Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID
[**Get-Segments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
[**New-Segment**](#create-segment) | **POST** `/segments` | Create segment
[**Remove-Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id
[**Get-Segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id
[**Get-Segments**](#list-segments) | **GET** `/segments` | List segments
[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment
## create-segment
@@ -96,7 +96,7 @@ $Segment = @"{
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
}"@
# Create Segment
# Create segment
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
@@ -144,7 +144,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
# Delete segment by id
try {
Remove-Segment -Id $Id
@@ -190,7 +190,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
# Get segment by id
try {
Get-Segment -Id $Id
@@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$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)
# List Segments
# List segments
try {
Get-Segments
@@ -290,7 +290,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
$RequestBody = @"[{op=replace, path=/visibilityCriteria, 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 * owner * visibilityCriteria * active
# Update Segment
# Update segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody