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: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-transforms
title: Transforms
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/transforms
tags: ['SDK', 'Software Development Kit', 'Transforms', 'BetaTransforms']
---
# Transforms
Operations for creating, managing, and deleting transforms.
@@ -24,9 +24,7 @@ Method | HTTP request | Description
[**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-BetaTransform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
## create-transform
Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.
### Parameters
@@ -35,7 +33,6 @@ Param Type | Name | Data Type | Required | Description
Body | Transform | [**Transform**](../models/transform) | True | The transform to be created.
### Return type
[**TransformRead**](../models/transform-read)
### Responses
@@ -50,7 +47,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -77,7 +73,9 @@ $Transform = @"{
},
"type" : "dateFormat"
}"@
# Create transform
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-BetaTransform-BetaTransform $Result
@@ -89,11 +87,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-transform
Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform.
A token with transform delete authority is required to call this API.
@@ -103,7 +98,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the transform to delete
### Return type
(empty response body)
### Responses
@@ -118,14 +112,15 @@ Code | Description | Data Type
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 = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
# Delete a transform
try {
Remove-BetaTransform-BetaId $Id
@@ -136,11 +131,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-transform
This API returns the transform specified by the given ID.
A token with transform read authority is required to call this API.
@@ -150,7 +142,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | ID of the transform to retrieve
### Return type
[**TransformRead**](../models/transform-read)
### Responses
@@ -165,14 +156,15 @@ Code | Description | Data Type
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 = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve
# Transform by ID
try {
Get-BetaTransform-BetaId $Id
@@ -183,11 +175,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-transforms
Gets a list of all saved transform objects.
A token with transforms-list read authority is required to call this API.
@@ -201,7 +190,6 @@ Param Type | Name | Data Type | Required | Description
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: **internal**: *eq* **name**: *eq, sw*
### Return type
[**TransformRead[]**](../models/transform-read)
### Responses
@@ -216,7 +204,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -227,7 +214,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$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)
$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional)
$Filters = 'name eq "Uppercase"' # 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: **internal**: *eq* **name**: *eq, sw* (optional)
# List transforms
try {
Get-BetaTransforms
@@ -238,11 +227,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-transform
Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error.
A token with transform write authority is required to call this API.
@@ -253,7 +239,6 @@ Path | Id | **String** | True | ID of the transform to update
Body | Transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include ""name"", ""type"", and ""attributes"" fields, but ""name"" and ""type"" must not be modified.
### Return type
[**TransformRead**](../models/transform-read)
### Responses
@@ -268,7 +253,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -296,7 +280,9 @@ $Transform = @"{
},
"type" : "dateFormat"
}"@
# Update a transform
try {
Update-BetaTransform-BetaId $Id
@@ -307,7 +293,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)