Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@

Documentation

The SailPoint CLI is a terminal-based tool you can use to to interact with your Identity Security Cloud (ISC) tenant. The CLI provides a text-based environment you can use to run operations known as "commands" to interact with your tenant however you want.
The SailPoint CLI is a terminal-based tool you can use to to interact with your SailPoint Identity Security tenant. The CLI provides a text-based environment you can use to run operations known as "commands" to interact with your tenant however you want.

For documentation, please see https://developer.sailpoint.com/docs/tools/cli
2 changes: 1 addition & 1 deletion cmd/api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Command

The `api` command allows you to make direct API requests to SailPoint Identity Security Cloud endpoints.
The `api` command allows you to make direct API requests to SailPoint Identity Security endpoints.

Similar to the GitHub CLI's `api` command, this provides a simple way to hit any custom API endpoint with custom headers, parameters, and content.

Expand Down
2 changes: 1 addition & 1 deletion cmd/cluster/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ func NewClusterCommand() *cobra.Command {
help := util.ParseHelp(clusterHelp)
cmd := &cobra.Command{
Use: "cluster",
Short: "Manage clusters in Identity Security Cloud",
Short: "Manage clusters in SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Aliases: []string{"cl"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/cluster/cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
==Long==
# Cluster

Manage Identity Security Cloud VA clusters.
Manage SailPoint Identity Security VA clusters.

## API Reference:
- https://developer.sailpoint.com/docs/api/beta/managed-clusters
Expand Down
2 changes: 1 addition & 1 deletion cmd/cluster/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func newGetCommand() *cobra.Command {
help := util.ParseHelp(getHelp)
cmd := &cobra.Command{
Use: "get",
Short: "Get a cluster from Identity Security Cloud",
Short: "Get a cluster from SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Aliases: []string{"get"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/cluster/get.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
==Long==
# Get

Get a VA cluster's configuration from Identity Security Cloud.
Get a VA cluster's configuration from SailPoint Identity Security.

## API References:
- https://developer.sailpoint.com/docs/api/beta/get-managed-cluster
Expand Down
2 changes: 1 addition & 1 deletion cmd/cluster/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func newListCommand() *cobra.Command {
help := util.ParseHelp(listHelp)
cmd := &cobra.Command{
Use: "list",
Short: "List the clusters configured in Identity Security Cloud",
Short: "List the clusters configured in SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Aliases: []string{"ls"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/cluster/list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
==Long==
# List

List all VA clusters from Identity Security Cloud.
List all VA clusters from SailPoint Identity Security.

## API References:
- https://developer.sailpoint.com/docs/api/beta/get-managed-clusters
Expand Down
12 changes: 6 additions & 6 deletions cmd/connector/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Connectors

The `connectors` command is a CLI interface for the SaaS Connectivity Platform. This CLI is the best way to create and manage SaaS connectors within your Identity Security Cloud tenant. Please [read our saas connectivity guide](https://developer.sailpoint.com/docs/connectivity/saas-connectivity) for more information.
The `connectors` command is a CLI interface for the SaaS Connectivity Platform. This CLI is the best way to create and manage SaaS connectors within your SailPoint Identity Security tenant. Please [read our saas connectivity guide](https://developer.sailpoint.com/docs/connectivity/saas-connectivity) for more information.

- [Init project](#init-project)
- [Create connector](#create-connector)
Expand All @@ -24,7 +24,7 @@ This command will create a folder in your current working directory with the sam

## Create connector

To create a connector entry in your Identity Security Cloud tenant, run the following command.
To create a connector entry in your SailPoint Identity Security tenant, run the following command.

```shell
sail conn create [connectorAlias]
Expand All @@ -34,7 +34,7 @@ This will register your connector and give it a unique ID. See [creating a conn

## Upload connector

To upload a connector to your Identity Security Cloud tenant, package the connector into a zip file by running `npm run pack-zip` in the project directory and then run the following command.
To upload a connector to your SailPoint Identity Security tenant, package the connector into a zip file by running `npm run pack-zip` in the project directory and then run the following command.

```shell
sail conn upload -c [connectorID | connectorAlias] -f connector.zip
Expand All @@ -56,7 +56,7 @@ The entitlement commands require an additional flag (`-t [entitlementType]`). F
sail conn invoke entitlement-list -t [entitlementType] -c [connectorID | connectorAlias] -p [config.json] -v [version]
```

See [testing your connection in Identity Security Cloud](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/test-build-deploy/#test-your-connector-in-identity-security-cloud) for more information on invoking commands.
See [testing your connection in SailPoint Identity Security](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/test-build-deploy/#test-your-connector-in-identity-security-cloud) for more information on invoking commands.

## List connectors

Expand Down Expand Up @@ -84,7 +84,7 @@ sail conn delete -c [connectorID]

## Manage tags

Tags allow you to create multiple instances of your connector that can be used in Identity Security Cloud. The `latest` tag is created by default and is the primary instance, typically used for production purposes. Tags are similar to branches in a version control system, like git or CVS. You can create a tag for actively developing the connector, or for any other purpose you see fit.
Tags allow you to create multiple instances of your connector that can be used in SailPoint Identity Security. The `latest` tag is created by default and is the primary instance, typically used for production purposes. Tags are similar to branches in a version control system, like git or CVS. You can create a tag for actively developing the connector, or for any other purpose you see fit.

A common pattern is to create a `development` tag on a connector from a specific version, like the latest version.

Expand All @@ -98,7 +98,7 @@ As the connector is developed and the version number increases, update the `deve
sail conn tags update -c [connectorID | connectorAlias] -n [tagName] -v [version]
```

You can test the connector in Identity Security Cloud by selecting the instance of your connector with the `development` tag, which will use whatever version you point to with the update command.
You can test the connector in SailPoint Identity Security by selecting the instance of your connector with the `development` tag, which will use whatever version you point to with the update command.

To see all of the tags of the connector and what version they point to, run the following command.

Expand Down
2 changes: 1 addition & 1 deletion cmd/environment/environment.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
==Long==
# Environment

Configure SailPoint Identity Security Cloud environments for the CLI
Configure SailPoint Identity Security environments for the CLI
====

==Example==
Expand Down
2 changes: 1 addition & 1 deletion cmd/reassign/reassign.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ func NewReassignCommand() *cobra.Command {
help := util.ParseHelp(reassignHelp)
cmd := &cobra.Command{
Use: "reassign",
Short: "Reassign object ownership in Identity Security Cloud",
Short: "Reassign object ownership in SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Args: cobra.OnlyValidArgs,
Expand Down
2 changes: 1 addition & 1 deletion cmd/reassign/reassign.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Reassign

Run this command to reassign object ownership in Identity Security Cloud.
Run this command to reassign object ownership in SailPoint Identity Security.

You can reassign ownership for the following supported object types:

Expand Down
2 changes: 1 addition & 1 deletion cmd/report/report.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func NewReportCommand() *cobra.Command {
var template string
cmd := &cobra.Command{
Use: "report",
Short: "Generate a report from a template using Identity Security Cloud search queries",
Short: "Generate a report from a template using SailPoint Identity Security search queries",
Long: help.Long,
Example: help.Example,
Aliases: []string{"rep"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/report/report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
==Long==
# Report

Generate a report from Identity Security Cloud.
Generate a report from SailPoint Identity Security.

## API References:
- https://developer.sailpoint.com/docs/api/v3/search
Expand Down
2 changes: 1 addition & 1 deletion cmd/root/root.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==Long==
# SailPoint CLI
The SailPoint CLI allows you to administer your Identity Security Cloud tenant from the command line.
The SailPoint CLI allows you to administer your SailPoint Identity Security tenant from the command line.

Navigate to the [CLI Documentation](https://developer.sailpoint.com/docs/tools/cli) for more information.

Expand Down
4 changes: 2 additions & 2 deletions cmd/rule/download.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ func newDownloadCommand() *cobra.Command {

cmd := &cobra.Command{
Use: "download",
Short: "Download all rules in Identity Security Cloud",
Long: "\nDownload all rules in Identity Security Cloud\n\n",
Short: "Download all rules in SailPoint Identity Security",
Long: "\nDownload all rules in SailPoint Identity Security\n\n",
Example: "sail rule download",
Aliases: []string{"d"},
Args: cobra.NoArgs,
Expand Down
4 changes: 2 additions & 2 deletions cmd/rule/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ func newListCommand() *cobra.Command {

cmd := &cobra.Command{
Use: "list",
Short: "List all rules in Identity Security Cloud",
Long: "\nList all rules in Identity Security Cloud\n\n",
Short: "List all rules in SailPoint Identity Security",
Long: "\nList all rules in SailPoint Identity Security\n\n",
Example: "sail rule list | sail rule ls",
Aliases: []string{"ls"},
Args: cobra.NoArgs,
Expand Down
4 changes: 2 additions & 2 deletions cmd/rule/rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import (
func NewRuleCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "rule",
Short: "Manage rules in Identity Security Cloud",
Long: "\nManage rules in Identity Security Cloud\n\n",
Short: "Manage rules in SailPoint Identity Security",
Long: "\nManage rules in SailPoint Identity Security\n\n",
Example: "sail rule",
Run: func(cmd *cobra.Command, args []string) {
cmd.Help()
Expand Down
14 changes: 7 additions & 7 deletions cmd/search/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Search

In Identity Security Cloud, you can search all the sources connected to your tenant and return virtually any information you have access to. To learn more about search in Identity Security Cloud, refer to [Search](https://documentation.sailpoint.com/saas/help/search/index.html).
In SailPoint Identity Security, you can search all the sources connected to your tenant and return virtually any information you have access to. To learn more about search in SailPoint Identity Security, refer to [Search](https://documentation.sailpoint.com/saas/help/search/index.html).

The `search` command makes it easy to search in Identity Security Cloud with the SailPoint CLI. Read this guide to learn how to use the `query` and `template` commands to search Identity Security Cloud with the CLI.
The `search` command makes it easy to search in SailPoint Identity Security with the SailPoint CLI. Read this guide to learn how to use the `query` and `template` commands to search SailPoint Identity Security with the CLI.

- [Search](#search)
- [Query](#query)
Expand All @@ -20,11 +20,11 @@ The `search` command makes it easy to search in Identity Security Cloud with the

## Query

Search queries in Identity Security Cloud are flexible - they can be very broad or very narrow, and you can further narrow your results by using Identity Security Cloud's specific syntax to structure your queries. To learn about structuring search queries, refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html).
Search queries in SailPoint Identity Security are flexible - they can be very broad or very narrow, and you can further narrow your results by using SailPoint Identity Security's specific syntax to structure your queries. To learn about structuring search queries, refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html).

The `query` command allows you to search Identity Security Cloud for a query you specify.
The `query` command allows you to search SailPoint Identity Security for a query you specify.

To use the `query` command to search Identity Security Cloud, you must understand how to format your search queries.
To use the `query` command to search SailPoint Identity Security, you must understand how to format your search queries.

The basic format of a query is "field:term", so an example `query` command would like this:

Expand Down Expand Up @@ -115,7 +115,7 @@ sail search query "name:a*" --indices identities --folderPath ./local/folder/pat

For more detailed search queries, you can provide a predefined template instead of constructing the whole query every time. This allows you to run very detailed search queries quickly and easily.

The `template` command allows you to use predefined templates to search Identity Security Cloud.
The `template` command allows you to use predefined templates to search SailPoint Identity Security.

### Command

Expand All @@ -125,7 +125,7 @@ This example shows the essential `template` command structure:
sail search template all-provisioning-events-90-days
```

The specified template file will give the CLI all the information it needs to perform its search in Identity Security Cloud.
The specified template file will give the CLI all the information it needs to perform its search in SailPoint Identity Security.

### Flags

Expand Down
2 changes: 1 addition & 1 deletion cmd/search/query.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func newQueryCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "query",
Short: "Manually search using a specific query and indices",
Long: "\nRun a search query in Identity Security Cloud, using a specific query and indicies\n\n",
Long: "\nRun a search query in SailPoint Identity Security, using a specific query and indicies\n\n",
Example: "sail search query \"(type:provisioning AND created:[now-90d TO now])\" --indices events",
Aliases: []string{"que"},
Args: cobra.ExactArgs(1),
Expand Down
4 changes: 2 additions & 2 deletions cmd/search/search.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import (
func NewSearchCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "search",
Short: "Perform search operations in Identity Security Cloud, using a specific query or a template",
Long: "\nPerform search operations in Identity Security Cloud, using a specific query or a template\n\n",
Short: "Perform search operations in SailPoint Identity Security, using a specific query or a template",
Long: "\nPerform search operations in SailPoint Identity Security, using a specific query or a template\n\n",
Example: "sail search",
Aliases: []string{"se"},
Args: cobra.MaximumNArgs(1),
Expand Down
4 changes: 2 additions & 2 deletions cmd/search/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ func newTemplateCmd() *cobra.Command {
var template string
cmd := &cobra.Command{
Use: "template",
Short: "Perform search operations in Identity Security Cloud, using a predefined search template",
Long: "\nPerform search operations in Identity Security Cloud, using a predefined search template\n\n",
Short: "Perform search operations in SailPoint Identity Security, using a predefined search template",
Long: "\nPerform search operations in SailPoint Identity Security, using a predefined search template\n\n",
Example: "sail search template",
Aliases: []string{"temp"},
Args: cobra.MaximumNArgs(1),
Expand Down
2 changes: 1 addition & 1 deletion cmd/set/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
func PromptAuth() (string, error) {
items := []tui.Choice{
{Title: "PAT", Description: "Person Access Token - Single User PAT Configuration"},
{Title: "OAuth", Description: "OAuth2.0 Authentication - Sign in via the Identity Security Cloud web portal"},
{Title: "OAuth", Description: "OAuth2.0 Authentication - Sign in via the SailPoint Identity Security web portal"},
}

choice, err := tui.PromptList(items, "Choose an authentication method to configure")
Expand Down
4 changes: 2 additions & 2 deletions cmd/set/searchTemplates.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import (
func newSearchTemplateCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "searchTemplates",
Short: "Set the custom Identity Security Cloud search templates file path",
Long: "\nSet the custom Identity Security Cloud search templates file path\n\n",
Short: "Set the custom SailPoint Identity Security search templates file path",
Long: "\nSet the custom SailPoint Identity Security search templates file path\n\n",
Example: "sail set search /path/to/search/templates.json",
Aliases: []string{"search"},
Args: cobra.ExactArgs(1),
Expand Down
4 changes: 2 additions & 2 deletions cmd/spconfig/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SP-Config

The `spconfig` command makes it easy to perform import and export operations in Identity Security Cloud using the SailPoint CLI.
The `spconfig` command makes it easy to perform import and export operations in SailPoint Identity Security using the SailPoint CLI.

- [SP-Config](#sp-config)
- [Download](#download)
Expand Down Expand Up @@ -77,7 +77,7 @@ sail spconfig download \

### Command

Run the following command to begin an spconfig export job in Identity Security Cloud
Run the following command to begin an spconfig export job in SailPoint Identity Security

```shell
sail spconfig export \
Expand Down
2 changes: 1 addition & 1 deletion cmd/spconfig/download.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func newDownloadCommand() *cobra.Command {
var folderPath string
cmd := &cobra.Command{
Use: "download {--import <importID> --export <exportID>}",
Short: "Download the results of import or export jobs from Identity Security Cloud",
Short: "Download the results of import or export jobs from SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Aliases: []string{"down"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/spconfig/download.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
==Long==
# Download

Download the results of import or export jobs from Identity Security Cloud.
Download the results of import or export jobs from SailPoint Identity Security.

====

Expand Down
2 changes: 1 addition & 1 deletion cmd/spconfig/export.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func newExportCommand() *cobra.Command {

cmd := &cobra.Command{
Use: "export",
Short: "Start an export job in Identity Security Cloud",
Short: "Start an export job in SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Aliases: []string{"exp"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/spconfig/export.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==Long==
# Export
Start an export job in Identity Security Cloud.
Start an export job in SailPoint Identity Security.

You can include or exclude the following valid types:
- ACCESS_PROFILE
Expand Down
4 changes: 2 additions & 2 deletions cmd/spconfig/import.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ func newImportCommand() *cobra.Command {

cmd := &cobra.Command{
Use: "import",
Short: "Start an import job in Identity Security Cloud",
Long: "\nStart an import job in Identity Security Cloud\n\n",
Short: "Start an import job in SailPoint Identity Security",
Long: "\nStart an import job in SailPoint Identity Security\n\n",
Example: "sail spconfig import",
Aliases: []string{"imp"},
Args: cobra.NoArgs,
Expand Down
2 changes: 1 addition & 1 deletion cmd/spconfig/spconfig.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ func NewSPConfigCommand() *cobra.Command {
help := util.ParseHelp(spconfigHelp)
cmd := &cobra.Command{
Use: "spconfig",
Short: "Perform SPConfig operations in Identity Security Cloud",
Short: "Perform SPConfig operations in SailPoint Identity Security",
Long: help.Long,
Example: help.Example,
Aliases: []string{"spcon"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/spconfig/spconfig.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==Long==
# SPConfig
Perform SP-Config operations in Identity Security Cloud.
Perform SP-Config operations in SailPoint Identity Security.

API References:
- https://developer.sailpoint.com/docs/api/beta/sp-config
Expand Down
4 changes: 2 additions & 2 deletions cmd/spconfig/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ func newStatusCommand() *cobra.Command {
var importJobs []string
cmd := &cobra.Command{
Use: "status",
Short: "Get the status of SPConfig jobs in Identity Security Cloud",
Long: "\nGet the status of SPConfig jobs in Identity Security Cloud\n\n",
Short: "Get the status of SPConfig jobs in SailPoint Identity Security",
Long: "\nGet the status of SPConfig jobs in SailPoint Identity Security\n\n",
Example: "sail spconfig status --export 2b3b68f4-cfe7-43a6-8fb0-a518c6218111",
Aliases: []string{"stat"},
Args: cobra.NoArgs,
Expand Down
Loading
Loading