Close-up of a developer's hands on a laptop with holographic code imports and configuration files floating in the foreground.

SailPoint CLI – Commands, Automation & Configuration Guide

Date Posted:

11 Dec 2024

Category:

Security

Author:

Kanibharathi

Close-up of a developer's hands on a laptop with holographic code imports and configuration files floating in the foreground.

SailPoint CLI – Commands, Automation & Configuration Guide

Date Posted:

11 Dec 2024

Category:

Security

Author:

Kanibharathi

Close-up of a developer's hands on a laptop with holographic code imports and configuration files floating in the foreground.

SailPoint CLI – Commands, Automation & Configuration Guide

Date Posted:

11 Dec 2024

Category:

Security

Author:

Kanibharathi

Introduction

SailPoint is a leading provider of identity management solutions, empowering organizations to securely and efficiently manage user access to applications, data, and systems. While SailPoint offers a user-friendly web interface for managing identities, the CLI provides a streamlined and efficient way to perform various identity management tasks programmatically or from the command line.

Before we set sail, Let’s ensure our ship is ready for the journey. To embark on our CLI adventure, you’ll need:

  1. Access Credentials: Ensure you have the credentials to authenticate with your Sailpoint instance.

  2. CLI Installation: If you haven’t already, install the Sailpoint CLI tool on your local machine. The installation process may vary depending on your platform, But Sailpoint provides comprehensive documentation to guide through it.

A command-line interface (CLI) showing a step-by-step setup for a new environment, including tenant URL configuration and PAT authentication.

To get an overview of available commands and flags using the Sail command, you can generally use the -h or --help flag.

Connectors

The connectors command is your go-to tool for creating and managing SaaS connectors within your tenant. To learn more about the options available with this command, use:

Sail connectors -h

A command-line interface (CLI) displaying help documentation for managing SailPoint connectors, including commands for creating, deleting, and updating connector projects.

Search

If you need to perform searches within the ISC, the Search command is what you need. Example search query:

CLI terminal executing a SailPoint search query for identities and access profiles, exporting results to JSON files.

Transform

We can create, update, list, download, update, delete transform using CLI.

CLI terminal showing available commands for managing SailPoint IdentityNow transforms, including create, delete, download, and update operations.

To download the transforms from the tenant to our system, run the following command.

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.

VA

To collect all the files from a VA, use sail va collect. This saves all the files to the current directory. To get the log files in human-readable format use parse.

CLI terminal displaying management commands for SailPoint virtual appliances (VA), including functions to collect files, list appliances, and parse log files.

SailPoint Config

Using CLI, Import and export of objects between the tenants can be done.

CLI terminal displaying SailPoint IdentityNow configuration management commands (spconfig) for exporting and importing workflows and sources.

Workflow

Whenever a specific event occurs, a set of steps called Workflows gets triggered.

CLI terminal displaying SailPoint IdentityNow workflow commands for creating, deleting, downloading, listing, and updating automation workflows.

Template

There are some predefined sets of queries available for Reports, SPConfig and Search. Some commands are:

  • Sail report

  • Sail Search template

  • Sail spconfig template.

Conclusion

The Command Line Interface (CLI) in SailPoint is a powerful tool for administrators and developers to manage and automate IdentityNow configurations and operations. It provides the flexibility to perform tasks such as managing connectors, running reports, configuring settings, and more—all from the command line.


Stay tuned to our blog to see more posts about

Sailpoint products implementation and its related updates.

Stay tuned to our blog to see more posts about

Sailpoint products implementation and its related updates.

Category:

Security

Stay tuned to our blog to see more posts about

Sailpoint products implementation and its related updates.

Stay tuned to our blog to see more posts about

Sailpoint products implementation and its related updates.

Category:

Category:

Security

Security

Get your

Tailored Quote for your

Organisation

Get your

Tailored Quote for your

Organisation

Introduction

SailPoint is a leading provider of identity management solutions, empowering organizations to securely and efficiently manage user access to applications, data, and systems. While SailPoint offers a user-friendly web interface for managing identities, the CLI provides a streamlined and efficient way to perform various identity management tasks programmatically or from the command line.

Before we set sail, Let’s ensure our ship is ready for the journey. To embark on our CLI adventure, you’ll need:

  1. Access Credentials: Ensure you have the credentials to authenticate with your Sailpoint instance.

  2. CLI Installation: If you haven’t already, install the Sailpoint CLI tool on your local machine. The installation process may vary depending on your platform, But Sailpoint provides comprehensive documentation to guide through it.

A command-line interface (CLI) showing a step-by-step setup for a new environment, including tenant URL configuration and PAT authentication.

To get an overview of available commands and flags using the Sail command, you can generally use the -h or --help flag.

Connectors

The connectors command is your go-to tool for creating and managing SaaS connectors within your tenant. To learn more about the options available with this command, use:

Sail connectors -h

A command-line interface (CLI) displaying help documentation for managing SailPoint connectors, including commands for creating, deleting, and updating connector projects.

Search

If you need to perform searches within the ISC, the Search command is what you need. Example search query:

CLI terminal executing a SailPoint search query for identities and access profiles, exporting results to JSON files.

Transform

We can create, update, list, download, update, delete transform using CLI.

CLI terminal showing available commands for managing SailPoint IdentityNow transforms, including create, delete, download, and update operations.

To download the transforms from the tenant to our system, run the following command.

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.

VA

To collect all the files from a VA, use sail va collect. This saves all the files to the current directory. To get the log files in human-readable format use parse.

CLI terminal displaying management commands for SailPoint virtual appliances (VA), including functions to collect files, list appliances, and parse log files.

SailPoint Config

Using CLI, Import and export of objects between the tenants can be done.

CLI terminal displaying SailPoint IdentityNow configuration management commands (spconfig) for exporting and importing workflows and sources.

Workflow

Whenever a specific event occurs, a set of steps called Workflows gets triggered.

CLI terminal displaying SailPoint IdentityNow workflow commands for creating, deleting, downloading, listing, and updating automation workflows.

Template

There are some predefined sets of queries available for Reports, SPConfig and Search. Some commands are:

  • Sail report

  • Sail Search template

  • Sail spconfig template.

Conclusion

The Command Line Interface (CLI) in SailPoint is a powerful tool for administrators and developers to manage and automate IdentityNow configurations and operations. It provides the flexibility to perform tasks such as managing connectors, running reports, configuring settings, and more—all from the command line.