Skip to main content

CLI Transforms

Learn about the CLI commands you can use to create, manage, and test transforms in this guide.

In Identity Security Cloud (ISC), you can use transforms to manipulate attribute data without writing any code. For more information about transforms, refer to Transforms.

With the transforms command, it's it easy to create, manage, and test transforms in the CLI.

Commands​

To create, manage, and test transforms with the CLI, you can use these commands:

List transforms​

To get a list of the transforms available in your tenant, run this command:

sail transform list

This command produces a table of available transforms.

Transform List

Download transforms​

To download all the transforms in your tenant and save them as json files on your computer, run the following command. By default, this command will save the files in the current working directory. Use the -d flag to specify a path to an output directory.

sail transform download -d transform_files

By default, this command will save the files in the current working directory. Use the -d flag to specify a path to an output directory.

Transform Download

This command will overwrite any existing files with the same name, so be careful when you run this in a directory that has transforms that have been modified but not yet saved.

Create transform​

To create a new transform from a json file, run the following command. Use the -f flag to specify the path to the json file.

sail transform create -f transform.json

Update transform​

To update a transform from a json file, run the following command. Use the -f flag to specify the path to the json file.

sail transform update -f transform.json

A common workflow is to first download the transforms, then make edits to the transform file, and then use the update command to save those edits in ISC.

Delete transform​

To delete a transform, run this command:

sail transform delete <transform-id>

To delete multiple transforms, use this syntax:

sail transform delete <transform-id> <transform-id> <transform-id>

You can use this command in conjunction with the ls command to find the ID of the transform you want to delete.

This is an example of how you can find a transform ID and delete it:

sail transform list
+--------------------------------------+--------------------------+
|                  ID                  |           NAME           |
+--------------------------------------+--------------------------+
| 03d5187b-ab96-402c-b5a1-40b74285d77a | WIFI Group               |
| 06d589cf-4d7d-4b40-8617-c221092ceb2c | Remove Diacritical Marks |
| 1f3a97cf-e58b-4fad-b2f2-0dcc19fb1627 | NETID                    |
+--------------------------------------+--------------------------+
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:

Transform Preview

Alternatively, you can directly specify the identity profile and identity using the following command:

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.