mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: transforms
|
||||
title: Transforms
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/transforms
|
||||
tags: ['SDK', 'Software Development Kit', 'Transforms', 'Transforms']
|
||||
---
|
||||
|
||||
|
||||
# Transforms
|
||||
The purpose of this API is to expose functionality for the manipulation of Transform objects.
|
||||
Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having
|
||||
@@ -30,9 +30,7 @@ Method | HTTP request | Description
|
||||
[**Get-Transforms**](#list-transforms) | **GET** `/transforms` | List transforms
|
||||
[**Update-Transform**](#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.
|
||||
|
||||
### Parameters
|
||||
@@ -41,7 +39,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
|
||||
@@ -56,7 +53,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
|
||||
|
||||
@@ -83,7 +79,9 @@ $Transform = @"{
|
||||
},
|
||||
"type" : "dateFormat"
|
||||
}"@
|
||||
|
||||
# Create transform
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToTransform -Json $Transform
|
||||
New-Transform-Transform $Result
|
||||
@@ -95,11 +93,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.
|
||||
|
||||
### Parameters
|
||||
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | Id | **String** | True | ID of the transform to delete
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
@@ -123,14 +117,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-Transform-Id $Id
|
||||
|
||||
@@ -141,11 +136,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-transform
|
||||
|
||||
This API returns the transform specified by the given ID.
|
||||
|
||||
### Parameters
|
||||
@@ -154,7 +146,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
|
||||
@@ -169,14 +160,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-Transform-Id $Id
|
||||
|
||||
@@ -187,11 +179,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-transforms
|
||||
|
||||
Gets a list of all saved transform objects.
|
||||
|
||||
### Parameters
|
||||
@@ -204,7 +193,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
|
||||
@@ -219,7 +207,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
|
||||
|
||||
@@ -230,7 +217,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-Transforms
|
||||
|
||||
@@ -241,11 +230,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.
|
||||
|
||||
### Parameters
|
||||
@@ -255,7 +241,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
|
||||
@@ -270,7 +255,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
|
||||
|
||||
@@ -298,7 +282,9 @@ $Transform = @"{
|
||||
},
|
||||
"type" : "dateFormat"
|
||||
}"@
|
||||
|
||||
# Update a transform
|
||||
|
||||
try {
|
||||
Update-Transform-Id $Id
|
||||
|
||||
@@ -309,7 +295,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user