mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
Add docs for cli transform preview
This commit is contained in:
BIN
docs/tools/cli/assets/img/vhs/transform-preview.gif
Normal file
BIN
docs/tools/cli/assets/img/vhs/transform-preview.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.0 MiB |
@@ -27,6 +27,7 @@ To create, manage, and test transforms with the CLI, you can use these commands:
|
|||||||
- [Create transform](#create-transform)
|
- [Create transform](#create-transform)
|
||||||
- [Update transform](#update-transform)
|
- [Update transform](#update-transform)
|
||||||
- [Delete transform](#delete-transform)
|
- [Delete transform](#delete-transform)
|
||||||
|
- [Preview transform](#preview-transform)
|
||||||
|
|
||||||
## List transforms
|
## List transforms
|
||||||
|
|
||||||
@@ -101,3 +102,29 @@ sail transform list
|
|||||||
+--------------------------------------+--------------------------+
|
+--------------------------------------+--------------------------+
|
||||||
sail transform delete 03d5187b-ab96-402c-b5a1-40b74285d77a
|
sail transform delete 03d5187b-ab96-402c-b5a1-40b74285d77a
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Preview transform
|
||||||
|
|
||||||
|
Use this command to preview a transform in your environment. The command offers two modes based upon the input:
|
||||||
|
|
||||||
|
- **Interactive Mode**: Walk through the process interactively, providing the identity profile and identity as inputs dynamically.
|
||||||
|
|
||||||
|
- **Direct Mode**: Specify the identity profile and identity upfront for a quicker preview.
|
||||||
|
|
||||||
|
Both modes display the transform result along with the associated identity attributes in a table format, giving you a clear overview of the applied transformation.
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
This command temporarily creates and deletes a transform in your environment to generate the preview.
|
||||||
|
:::
|
||||||
|
|
||||||
|
Below is an example of Interactive Mode, where you'll provide inputs dynamically:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Alternatively, you can directly specify the identity profile and identity using the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sail transform preview --profile 8b9960eebbdd43029393edd9dcf25976 --identity 1d2d747380634a38a48f079422833ed6 --file transform_files/DeriveFirstInitialLastNameInUpper.json
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also include a flag `--result-only` or `-r` to return only the transform result, which is useful for creating tests or automating validation workflows.
|
||||||
|
|||||||
Reference in New Issue
Block a user