mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Prettified Code!
This commit is contained in:
darrell-thobe-sp
committed by
GitHub Action
GitHub Action
parent
f5b6aaf14f
commit
2cd5ccfc81
@@ -43,9 +43,9 @@ This is the report template anatomy:
|
||||
"name": "provisioning-and-security",
|
||||
```
|
||||
|
||||
This is the report template's name.
|
||||
This is the report template's name.
|
||||
|
||||
It displays in the template list when you run `sail report`.
|
||||
It displays in the template list when you run `sail report`.
|
||||
|
||||
You can also provide the name as an argument: `sail report provisioning-and-security`
|
||||
|
||||
@@ -53,17 +53,17 @@ You can also provide the name as an argument: `sail report provisioning-and-secu
|
||||
"description": "All account unlocks in the tenant for a given time range",
|
||||
```
|
||||
|
||||
This is the report template's description.
|
||||
This is the report template's description.
|
||||
|
||||
It displays following the template name in the `sail report` list.
|
||||
It displays following the template name in the `sail report` list.
|
||||
|
||||
```json
|
||||
"variables": [{"name": "days", "prompt": "Days before today"}],
|
||||
```
|
||||
|
||||
Use variables to dynamically populate values in the following content during command run time.
|
||||
Use variables to dynamically populate values in the following content during command run time.
|
||||
|
||||
For example, the variable in this template is configured so you can choose how many days back you want to search for provisioning-and-security events. When you run `sail report provisioning-and-security`, a prompt displays, `Input Days before today:` The number you enter will then populate anywhere the variable is used in the following object, and then the query runs.
|
||||
For example, the variable in this template is configured so you can choose how many days back you want to search for provisioning-and-security events. When you run `sail report provisioning-and-security`, a prompt displays, `Input Days before today:` The number you enter will then populate anywhere the variable is used in the following object, and then the query runs.
|
||||
|
||||
```json
|
||||
"queries": [
|
||||
@@ -81,4 +81,4 @@ For example, the variable in this template is configured so you can choose how m
|
||||
]
|
||||
```
|
||||
|
||||
This is a list of the queries that will run. Currently, the variables for days populate.
|
||||
This is a list of the queries that will run. Currently, the variables for days populate.
|
||||
|
||||
@@ -13,7 +13,7 @@ tags: ['CLI']
|
||||
|
||||
Use search templates to run predefined search queries from the CLI.
|
||||
|
||||
This is an example of a template file with 3 search templates populated:
|
||||
This is an example of a template file with 3 search templates populated:
|
||||
|
||||
```json
|
||||
[
|
||||
@@ -72,7 +72,7 @@ This is the search template anatomy:
|
||||
"name": "all-account-unlocks",
|
||||
```
|
||||
|
||||
This is the search template's name.
|
||||
This is the search template's name.
|
||||
|
||||
It displays in the template list when you run `sail search template`.
|
||||
|
||||
@@ -82,7 +82,7 @@ You can also provide this name as an argument: `sail search template all-account
|
||||
"description": "All account unlocks in the tenant for a given time range"
|
||||
```
|
||||
|
||||
This is the search template's description.
|
||||
This is the search template's description.
|
||||
|
||||
It displays following the template name in the `sail search template` list.
|
||||
|
||||
@@ -90,9 +90,9 @@ It displays following the template name in the `sail search template` list.
|
||||
"variables": [{"name": "days", "prompt": "Days before today"}],
|
||||
```
|
||||
|
||||
Use variables to dynamically populate values in the following content during command run time.
|
||||
Use variables to dynamically populate values in the following content during command run time.
|
||||
|
||||
For example, the variable in this template is configured so you can choose how many days back you want to search for account unlock events. When you run `sail search template all-account-unlocks`, a prompt displays, `Input Days before today:` The number you enter will then populate anywhere the variable is used in the following object, and then the query runs.
|
||||
For example, the variable in this template is configured so you can choose how many days back you want to search for account unlock events. When you run `sail search template all-account-unlocks`, a prompt displays, `Input Days before today:` The number you enter will then populate anywhere the variable is used in the following object, and then the query runs.
|
||||
|
||||
```json
|
||||
"searchQuery": {
|
||||
|
||||
@@ -6,7 +6,7 @@ sidebar_label: SPConfig
|
||||
sidebar_position: 10
|
||||
sidebar_class_name: cli-template-spconfig
|
||||
keywords: ['cli', 'template', 'spconfig']
|
||||
description: Learn about the SPConfig template commands you can use to import and export configurations from the CLI.
|
||||
description: Learn about the SPConfig template commands you can use to import and export configurations from the CLI.
|
||||
slug: /tools/cli/templates/spconfig
|
||||
tags: ['CLI']
|
||||
---
|
||||
@@ -45,7 +45,7 @@ This is the SPConfig template anatomy:
|
||||
"name": "all-objects",
|
||||
```
|
||||
|
||||
This is the SPConfig template's name.
|
||||
This is the SPConfig template's name.
|
||||
|
||||
The SPConfig template name displays in the template list when you run `sail spconfig template`.
|
||||
|
||||
@@ -55,7 +55,7 @@ You can also provide this name as an argument: `sail spconfig template all-objec
|
||||
"description": "Export all available objects",
|
||||
```
|
||||
|
||||
This is the SPConfig template's description.
|
||||
This is the SPConfig template's description.
|
||||
|
||||
in the `sail spconfig template` list
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"customProps": {
|
||||
"description": "Terminal based tool for interaction with ISC."
|
||||
}
|
||||
}
|
||||
"customProps": {
|
||||
"description": "Terminal based tool for interaction with ISC."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,45 +13,45 @@ tags: ['CLI']
|
||||
|
||||
# Clusters
|
||||
|
||||
Learn how to use the SailPoint CLI to list manage client managed clusters in this guide.
|
||||
Learn how to use the SailPoint CLI to list manage client managed clusters in this guide.
|
||||
|
||||
The `cluster` command makes it easy to manage clusters within the CLI.
|
||||
The `cluster` command makes it easy to manage clusters within the CLI.
|
||||
|
||||
- [Clusters](#clusters)
|
||||
- [List clusters](#list-clusters)
|
||||
- [Get cluster by ID](#get-cluster-by-id)
|
||||
- [Get cluster's log configuration](#get-clusters-log-configuration)
|
||||
- [Set cluster's log configuration](#set-clusters-log-configuration)
|
||||
- [List clusters](#list-clusters)
|
||||
- [Get cluster by ID](#get-cluster-by-id)
|
||||
- [Get cluster's log configuration](#get-clusters-log-configuration)
|
||||
- [Set cluster's log configuration](#set-clusters-log-configuration)
|
||||
|
||||
## List clusters
|
||||
|
||||
To manage clusters in the SailPoint CLI, you need to know which clusters are available, as well as their IDs. Run this command to list the clusters connected to your tenant:
|
||||
To manage clusters in the SailPoint CLI, you need to know which clusters are available, as well as their IDs. Run this command to list the clusters connected to your tenant:
|
||||
|
||||
```shell
|
||||
sail cluster list
|
||||
sail cluster list
|
||||
```
|
||||
|
||||
This command returns a table of the clusters, along with their IDs.
|
||||
This command returns a table of the clusters, along with their IDs.
|
||||
|
||||
This command uses the [Get all clusters endpoint](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters).
|
||||
|
||||
## Get cluster by ID
|
||||
|
||||
Once you have a cluster's ID, you can see view all its details. Run this command to get a cluster by ID:
|
||||
Once you have a cluster's ID, you can see view all its details. Run this command to get a cluster by ID:
|
||||
|
||||
```shell
|
||||
sail cluster get {cluster ID}
|
||||
```
|
||||
|
||||
Here is an example command:
|
||||
Here is an example command:
|
||||
|
||||
```shell
|
||||
sail cluster get f48e8c9c7dce4672bead8222a767dce7
|
||||
```
|
||||
|
||||
The CLI will return the cluster, along with all its details.
|
||||
The CLI will return the cluster, along with all its details.
|
||||
|
||||
You can also get multiple clusters at once. Here is an example:
|
||||
You can also get multiple clusters at once. Here is an example:
|
||||
|
||||
```shell
|
||||
sail cluster get f48e8c9c7dce4672bead8222a767dce7 3652192cc2264ad5827fdc1eb2d88f01
|
||||
@@ -61,13 +61,13 @@ This command uses the [Get cluster endpoint](https://developer.sailpoint.com/doc
|
||||
|
||||
## Get cluster's log configuration
|
||||
|
||||
The VA clusters have logs that track their activity, and you can view these logs' configurations and make changes to them. To get a cluster's log configuration, run this command:
|
||||
The VA clusters have logs that track their activity, and you can view these logs' configurations and make changes to them. To get a cluster's log configuration, run this command:
|
||||
|
||||
```shell
|
||||
sail cluster log get {cluster ID}
|
||||
```
|
||||
|
||||
Here is an example:
|
||||
Here is an example:
|
||||
|
||||
```shell
|
||||
sail cluster log get 2c91808580f6cc1a01811af8cf5f18cb
|
||||
@@ -77,7 +77,7 @@ This command uses the [Get cluster's log configuration endpoint](https://develop
|
||||
|
||||
## Set cluster's log configuration
|
||||
|
||||
You can update a cluster's root logging level, the duration of its logging, and the connector logging class. To set a cluster's log configuration, run this command:
|
||||
You can update a cluster's root logging level, the duration of its logging, and the connector logging class. To set a cluster's log configuration, run this command:
|
||||
|
||||
This command uses the [Update cluster's log configuration endpoint](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration).
|
||||
|
||||
@@ -85,16 +85,12 @@ This command uses the [Update cluster's log configuration endpoint](https://deve
|
||||
sail cluster log set {cluster ID} -r {rootLevel} -d {durationMinutes} -c {connector logging class}
|
||||
```
|
||||
|
||||
Here is an example:
|
||||
Here is an example:
|
||||
|
||||
```shell
|
||||
sail cluster log set 2c91808580f6cc1a01811af8cf5f18cb -r TRACE -d 30 -c sailpoint.connector.ADLDAPConnector=TRACE
|
||||
sail cluster log set 2c91808580f6cc1a01811af8cf5f18cb -r TRACE -d 30 -c sailpoint.connector.ADLDAPConnector=TRACE
|
||||
```
|
||||
|
||||
This example command sets the "TRACE" root logging level, a duration of 30 minutes, and a connector logging class of "sailpoint.connector.ADLDAPConnector=TRACE".
|
||||
|
||||
Refer to your respective [connector guide](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) to see which connector logging classes are available.
|
||||
|
||||
|
||||
|
||||
This example command sets the "TRACE" root logging level, a duration of 30 minutes, and a connector logging class of "sailpoint.connector.ADLDAPConnector=TRACE".
|
||||
|
||||
Refer to your respective [connector guide](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) to see which connector logging classes are available.
|
||||
|
||||
@@ -15,13 +15,13 @@ tags: ['CLI']
|
||||
|
||||
Learn how to use the CLI to create, manage, and test SaaS connectors in this guide.
|
||||
|
||||
You can use SaaS connectors to serve as bridges between your Identity Security Cloud (ISC) tenant and other source systems without the use of a Virtual Appliance (VA). For more information about the SaaS connectors, refer to the [SaaS Connectivity](/docs/connectivity/saas-connectivity) guide.
|
||||
You can use SaaS connectors to serve as bridges between your Identity Security Cloud (ISC) tenant and other source systems without the use of a Virtual Appliance (VA). For more information about the SaaS connectors, refer to the [SaaS Connectivity](/docs/connectivity/saas-connectivity) guide.
|
||||
|
||||
The `connectors` command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create, manage, and test SaaS connectors within your tenant.
|
||||
The `connectors` command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create, manage, and test SaaS connectors within your tenant.
|
||||
|
||||
## Commands
|
||||
## Commands
|
||||
|
||||
To create, manage, and test SaaS connectors with the CLI, you can run these commands:
|
||||
To create, manage, and test SaaS connectors with the CLI, you can run these commands:
|
||||
|
||||
- [Init project](#init-project)
|
||||
- [Create connector](#create-connector)
|
||||
@@ -36,13 +36,13 @@ To create, manage, and test SaaS connectors with the CLI, you can run these comm
|
||||
|
||||
### Init project
|
||||
|
||||
To initialize a connector project, run this command:
|
||||
To initialize a connector project, run this command:
|
||||
|
||||
```shell
|
||||
sail conn init [connectorProjectName]
|
||||
```
|
||||
|
||||
This command creates a folder named `connectorProjectName` in your working directory. The folder includes all the files necessary to create a connector. For more information about initiating a connector project, refer to the [Create new project](/docs/connectivity/saas-connectivity/prerequisites/#create-new-project) section of the SaaS Connectivity documentation.
|
||||
This command creates a folder named `connectorProjectName` in your working directory. The folder includes all the files necessary to create a connector. For more information about initiating a connector project, refer to the [Create new project](/docs/connectivity/saas-connectivity/prerequisites/#create-new-project) section of the SaaS Connectivity documentation.
|
||||
|
||||
### Create connector
|
||||
|
||||
@@ -52,7 +52,7 @@ To create a connector entry in your ISC tenant, run this command:
|
||||
sail conn create [connectorAlias]
|
||||
```
|
||||
|
||||
This command registers your connector and gives it a unique ID. For more information about creating a connector in your tenant, refer to the [Create connector in your org](/docs/connectivity/saas-connectivity/test-build-deploy#create-connector-in-your-org) section of the SaaS Connectivity documentation.
|
||||
This command registers your connector and gives it a unique ID. For more information about creating a connector in your tenant, refer to the [Create connector in your org](/docs/connectivity/saas-connectivity/test-build-deploy#create-connector-in-your-org) section of the SaaS Connectivity documentation.
|
||||
|
||||
### Upload connector
|
||||
|
||||
@@ -62,7 +62,7 @@ To upload a connector to your ISC tenant, run `npm run pack-zip` in the project
|
||||
sail conn upload -c [connectorID | connectorAlias] -f connector.zip
|
||||
```
|
||||
|
||||
You must package the project files before you upload them. For more information about how to package and upload connectors, refer to the [Create and upload connector bundle](/docs/connectivity/saas-connectivity/test-build-deploy/#create-and-upload-connector-bundle) section of the SaaS Connectivity documentation.
|
||||
You must package the project files before you upload them. For more information about how to package and upload connectors, refer to the [Create and upload connector bundle](/docs/connectivity/saas-connectivity/test-build-deploy/#create-and-upload-connector-bundle) section of the SaaS Connectivity documentation.
|
||||
|
||||
### Invoke command
|
||||
|
||||
@@ -74,13 +74,13 @@ sail conn invoke [command] -c [connectorID | connectorAlias] -p [config.json] -v
|
||||
|
||||
For more information about the different available connector commands, refer to [Connector Commands](/docs/connectivity/saas-connectivity/connector-commands).
|
||||
|
||||
The entitlement commands require an additional flag (`-t [entitlementType]`), like this example:
|
||||
The entitlement commands require an additional flag (`-t [entitlementType]`), like this example:
|
||||
|
||||
```shell
|
||||
sail conn invoke entitlement-list -t [entitlementType] -c [connectorID | connectorAlias] -p [config.json] -v [version]
|
||||
```
|
||||
|
||||
For more information about invoking commands, refer to the [Test your connector in Identity Security Cloud](/docs/connectivity/saas-connectivity/test-build-deploy#test-your-connector-in-identitynow) section of the SaaS Connectivity documentation.
|
||||
For more information about invoking commands, refer to the [Test your connector in Identity Security Cloud](/docs/connectivity/saas-connectivity/test-build-deploy#test-your-connector-in-identitynow) section of the SaaS Connectivity documentation.
|
||||
|
||||
### List connectors
|
||||
|
||||
@@ -100,15 +100,15 @@ sail conn update -c [connectorID] -a [newConnectorAlias]
|
||||
|
||||
### Validate a connector
|
||||
|
||||
You can use the CLI to validate your connector's behavior. The validate command runs integration tests against your connector to ensure all the basic functionality works.
|
||||
You can use the CLI to validate your connector's behavior. The validate command runs integration tests against your connector to ensure all the basic functionality works.
|
||||
|
||||
To validate a connector's behavior, run this command:
|
||||
To validate a connector's behavior, run this command:
|
||||
|
||||
```shell
|
||||
sail conn validate -c [connectorID]
|
||||
```
|
||||
|
||||
You can pass in a `-r` flag to run the command as read-only, or you can run a full suite of read/write tests.
|
||||
You can pass in a `-r` flag to run the command as read-only, or you can run a full suite of read/write tests.
|
||||
|
||||
## Delete connector
|
||||
|
||||
@@ -120,7 +120,7 @@ sail conn delete -c [connectorID]
|
||||
|
||||
### Manage tags
|
||||
|
||||
You can use tags to create multiple instances of your connector that can be used in ISC. 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 want.
|
||||
You can use tags to create multiple instances of your connector that can be used in ISC. 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 want.
|
||||
|
||||
A common pattern is to create a `development` tag on a connector from a specific version, like the latest version.
|
||||
|
||||
@@ -160,7 +160,7 @@ To get the output of logs in realtime, run this command:
|
||||
sail conn logs tail
|
||||
```
|
||||
|
||||
To filter the logs to a specific connector, use a utility like `grep`, like how it's used in this example:
|
||||
To filter the logs to a specific connector, use a utility like `grep`, like how it's used in this example:
|
||||
|
||||
```shell
|
||||
sail conn logs | grep 'connector version 29'
|
||||
|
||||
@@ -57,12 +57,10 @@ Note this installer is only compatible with 64 bit Windows.
|
||||
|
||||
:::
|
||||
|
||||
Download the latest release from the [releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases).
|
||||
The release should include an MSI file named `sail_x.x.x_windows_amd64.msi` that can be installed on Windows, with `x.x.x` being the version of the most recent release.
|
||||
Download the latest release from the [releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases). The release should include an MSI file named `sail_x.x.x_windows_amd64.msi` that can be installed on Windows, with `x.x.x` being the version of the most recent release.
|
||||
|
||||
To install the MSI file, double click on it and follow the prompts in the installer.
|
||||
|
||||
|
||||
### MacOS
|
||||
|
||||
MacOS users can use [Homebrew](https://brew.sh/) to install the CLI. Run these commands in your terminal:
|
||||
@@ -75,8 +73,7 @@ Then make sure you can run the `sail` command.
|
||||
|
||||
### Linux
|
||||
|
||||
Each release on the [releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases) includes a tarball that can be extracted and run on Linux.
|
||||
Or you can install using the available .deb or .rpm packages.
|
||||
Each release on the [releases page](https://github.com/sailpoint-oss/sailpoint-cli/releases) includes a tarball that can be extracted and run on Linux. Or you can install using the available .deb or .rpm packages.
|
||||
|
||||
#### Deb Package
|
||||
|
||||
@@ -87,6 +84,7 @@ Then install it using one of the following commands, with the `x.x.x` being the
|
||||
```bash
|
||||
sudo apt install ./sail_x.x.x_linux_amd64.deb
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo apt install /path/to/deb/package/sail_x.x.x_linux_amd64.deb
|
||||
```
|
||||
@@ -100,6 +98,7 @@ Then install it using one of the following commands, with the `x.x.x` being the
|
||||
```bash
|
||||
sudo yum localinstall ./sail_x.x.x_linux_amd64.rpm
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo yum localinstall /path/to/rpm/package/sail_x.x.x_linux_amd64.rpm
|
||||
```
|
||||
@@ -113,24 +112,25 @@ To configure the CLI to connect and authenticate to your ISC tenant, you must do
|
||||
- PAT | Create a personal access token (PAT). Make sure to note the "Client ID" and "Client Secret." The CLI needs this information to authenticate successfully. To learn how to create a PAT, refer to [Personal Access Tokens](/docs/api/authentication#personal-access-tokens).
|
||||
|
||||
To configure your first environment for OAuth run the following command:
|
||||
|
||||
```bash
|
||||
sail env {environment}
|
||||
```
|
||||
|
||||
with `{environment}` being the name of the environment you wish to configure.
|
||||
|
||||
You will be prompted for the following information:
|
||||
|
||||
- The Tenant URL - The web URL used to access your Identity Security Cloud tenant (ex. https://tenant.identitynow.com), this is used during the OAuth process.
|
||||
- The API URL - The API URL used to access your Identity Security Cloud tenant (ex. https://tenant.api.identitynow.com), this is used for the api calls made by certain commands.
|
||||
|
||||
### OAuth Authentication
|
||||
|
||||
With the default environment values populated you can immediately begin using the CLI with OAuth authentication.
|
||||
Just make sure OAuth is your selected authentication method, this can be done by running `sail set auth oauth`.
|
||||
With the default environment values populated you can immediately begin using the CLI with OAuth authentication. Just make sure OAuth is your selected authentication method, this can be done by running `sail set auth oauth`.
|
||||
|
||||
### PAT Authentication
|
||||
|
||||
After you have configured your environment, if you want to use PAT authentication, run the `sail set pat` command.
|
||||
You can then provide your PAT client ID and client secret.
|
||||
After you have configured your environment, if you want to use PAT authentication, run the `sail set pat` command. You can then provide your PAT client ID and client secret.
|
||||
|
||||
|
||||
|
||||
@@ -166,18 +166,17 @@ To get your environment variables to persist across PowerShell sessions, run thi
|
||||
[System.Environment]::SetEnvironmentVariable('SAIL_CLIENT_SECRET','clientSecret}')
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Run the `sail` command for an overview of available commands and flags. You can use the `-h` flag with any command to see additional options for each command:
|
||||
|
||||
These commands are available:
|
||||
|
||||
- `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/docs/tools/cli/connectors).
|
||||
- `search`: Run this command to access ISC search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/docs/tools/cli/search).
|
||||
- `connectors`: This command is a CLI interface for the SaaS Connectivity platform. The CLI is the best way to create and manage SaaS connectors within your tenant. For more information about the `connectors` command, refer to the CLI [Connectors guide](/docs/tools/cli/connectors).
|
||||
- `search`: Run this command to access ISC search functionality within the CLI. For more information about the `search` command, refer to the CLI [Search guide](/docs/tools/cli/search).
|
||||
- `set`: Run this command to configure your CLI settings. For more information about the `set` command, refer to the CLI [Set guide](/docs/tools/cli/set).
|
||||
- `spconfig`: Run this command to access ISC SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/docs/tools/cli/spconfig).
|
||||
- `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/docs/tools/cli/transforms).
|
||||
- `spconfig`: Run this command to access ISC SP Config functionality. For more information about the `spconfig` command, refer to the CLI [SPConfig guide](/docs/tools/cli/spconfig).
|
||||
- `transform`: This command is a CLI interface that makes it easy to create, manage, and test transforms. For more information about the `transform` command, refer to the CLI [Transforms guide](/docs/tools/cli/transforms).
|
||||
- `va`: Run this command to access VAs connected to your tenant. For more information about the `va` command, refer to the CLI [VA guide](/docs/tools/cli/va).
|
||||
- `cluster`: Run this command to access VA clusters connected to your tenant. For more information about the `cluster` command, refer to the CLI [Clusters guide](/docs/tools/cli/cluster).
|
||||
- `workflow`: Run this command to create and manage workflows within the CLI. For more information about the `workflow` command, refer to the CLI [Workflows guide](/docs/tools/cli/workflow).
|
||||
|
||||
@@ -11,7 +11,6 @@ slug: /tools/cli/sanitize
|
||||
tags: ['CLI']
|
||||
---
|
||||
|
||||
|
||||
## Sanitize
|
||||
|
||||
Learn how to use the CLI to sanitize your HAR files in this guide.
|
||||
@@ -28,21 +27,23 @@ The existing support guide for collecting and sanitizing the HAR file [can be fo
|
||||
|
||||
### Functionality
|
||||
|
||||
The sanitize command sanitizes a HAR file of sensitive data.
|
||||
It only removes access tokens matching the Identity Security Cloud format and origin urls similar to the examples below:
|
||||
The sanitize command sanitizes a HAR file of sensitive data. It only removes access tokens matching the Identity Security Cloud format and origin urls similar to the examples below:
|
||||
|
||||
Access Token
|
||||
|
||||
```
|
||||
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRfaWQiOiI1OGViMDZhNC1kY2Q3LTRlOTYtOGZhYy1jY2EyYWZjMDNlNjEiLCJpbnRlcm5hbCI6dHJ1ZSwicG9kIjoiY29vayIsIm9yZyI6ImV4YW1wbGUiLCJpZGVudGl0eV9pZCI6ImZmODA4MTgxNTVmZThjMDgwMTU1ZmU4ZDkyNWIwMzE2IiwidXNlcl9uYW1lIjoic2xwdC5zZXJ2aWNlcyIsInN0cm9uZ19hdXRoIjp0cnVlLCJhdXRob3JpdGllcyI6WyJPUkdfQURNSU4iXSwiY2xpZW50X2lkIjoibktCUE93akpIOExYU2pJbCIsInN0cm9uZ19hdXRoX3N1cHBvcnRlZCI6dHJ1ZSwidXNlcl9pZCI6IjU5NTgyNiIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJleHAiOjE1NjU4ODgzMTksImp0aSI6ImM5OGQxMjM2LTQ1MTMtNGM4OS1hMGQwLTBjYjlmMzI3NmI1NiJ9.SAY4ZQkXGi2cY_qz57Ah9_zDq4-bnF-oDJKotXa-LCY
|
||||
```
|
||||
|
||||
Origin URLs
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "origin",
|
||||
"value": "https://example.identitynow.com"
|
||||
"name": "origin",
|
||||
"value": "https://example.identitynow.com"
|
||||
}
|
||||
```
|
||||
|
||||
### Command
|
||||
|
||||
To use the CLI to sanitize HAR files, you can run this command:
|
||||
@@ -56,4 +57,3 @@ You can also sanitize multiple files at once:
|
||||
```shell
|
||||
sail sanitize ./path/to/har/file1.har ./path/to/har/file2.har ./path/to/har/file3.har
|
||||
```
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ In Identity Security Cloud (ISC), you can search across all the sources connecte
|
||||
|
||||
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).
|
||||
|
||||
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 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.
|
||||
|
||||
- [Search](#search)
|
||||
- [Query](#query)
|
||||
@@ -35,51 +35,51 @@ 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 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).
|
||||
|
||||
The `query` command allows you to search Identity Security Cloud for a query you specify.
|
||||
The `query` command allows you to search Identity Security Cloud 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 Identity Security Cloud, 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:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities
|
||||
```
|
||||
|
||||
The CLI will use the [V3 Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to search for all identities starting with names starting with the letter "a".
|
||||
The CLI will then generate a JSON file containing the search results. This JSON file will be located in a folder titled "search_results", within the current working directory, unless a folder path is specified.
|
||||
|
||||
### Command
|
||||
|
||||
This example can help you understand the `query` command structure:
|
||||
|
||||
```shell
|
||||
sail search query <search query string> --indices <index to search>
|
||||
```
|
||||
|
||||
You must start your search query with `sail search query`, and you must specify a query string to search for and a set of indices to search.
|
||||
|
||||
### Flags
|
||||
|
||||
You can append a number of flags to the `query` command to refine it:
|
||||
- The first flag, `indices`, is required. It specifies the indices to run the search operation on.
|
||||
- The second possible flag, `sort`, allows you to specify the sort strings to use for the search query, as well as the sorting arrangement for the results.
|
||||
- The third possible flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.
|
||||
|
||||
#### Indices
|
||||
|
||||
Use the `indices` flag to specify the indices you want to search. The `indices` flag is required to use the `query` command.
|
||||
|
||||
Here is an example of a `query` command with specified `indices`:
|
||||
The basic format of a query is "field:term", so an example `query` command would like this:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities
|
||||
```
|
||||
|
||||
You can search multiple indices.
|
||||
The CLI will use the [V3 Search endpoint](https://developer.sailpoint.com/docs/api/v3/search-post) to search for all identities starting with names starting with the letter "a". The CLI will then generate a JSON file containing the search results. This JSON file will be located in a folder titled "search_results", within the current working directory, unless a folder path is specified.
|
||||
|
||||
Here is an example of a `query` command with multiple specified `indices`.
|
||||
### Command
|
||||
|
||||
This example can help you understand the `query` command structure:
|
||||
|
||||
```shell
|
||||
sail search query <search query string> --indices <index to search>
|
||||
```
|
||||
|
||||
You must start your search query with `sail search query`, and you must specify a query string to search for and a set of indices to search.
|
||||
|
||||
### Flags
|
||||
|
||||
You can append a number of flags to the `query` command to refine it:
|
||||
|
||||
- The first flag, `indices`, is required. It specifies the indices to run the search operation on.
|
||||
- The second possible flag, `sort`, allows you to specify the sort strings to use for the search query, as well as the sorting arrangement for the results.
|
||||
- The third possible flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.
|
||||
|
||||
#### Indices
|
||||
|
||||
Use the `indices` flag to specify the indices you want to search. The `indices` flag is required to use the `query` command.
|
||||
|
||||
Here is an example of a `query` command with specified `indices`:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities
|
||||
```
|
||||
|
||||
You can search multiple indices.
|
||||
|
||||
Here is an example of a `query` command with multiple specified `indices`.
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities --indices accessprofiles
|
||||
@@ -87,18 +87,17 @@ sail search query "name:a*" --indices identities --indices accessprofiles
|
||||
|
||||
#### Sort
|
||||
|
||||
Use the `sort` flag to specify the sort strings you want to use to determine the sorting arrangement of your search query results.
|
||||
When you specify a string to sort by, like `name`, the CLI sorts results by `name` in ascending order. If you add a "-" before the sort string, like `-name`, the CLI will sort the results in descending order instead.
|
||||
Use the `sort` flag to specify the sort strings you want to use to determine the sorting arrangement of your search query results. When you specify a string to sort by, like `name`, the CLI sorts results by `name` in ascending order. If you add a "-" before the sort string, like `-name`, the CLI will sort the results in descending order instead.
|
||||
|
||||
Here is an example of a `query` command that sorts the results in descending order based on the identities' `created` dates:
|
||||
Here is an example of a `query` command that sorts the results in descending order based on the identities' `created` dates:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities --sort "-created"
|
||||
```
|
||||
|
||||
You can specify multiple sort strings for your search queries.
|
||||
You can specify multiple sort strings for your search queries.
|
||||
|
||||
Here is an example of a `query` command that sorts the results in ascending order based on `name`, as well as in descending order based on the identities' `created` dates:
|
||||
Here is an example of a `query` command that sorts the results in ascending order based on `name`, as well as in descending order based on the identities' `created` dates:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities --sort name --sort "-created"
|
||||
@@ -106,9 +105,9 @@ sail search query "name:a*" --indices identities --sort name --sort "-created"
|
||||
|
||||
#### Output Types
|
||||
|
||||
Use the `outputTypes` flag to specify the output data format for the search query results. Currently, the only supported output types are `json` and `csv`.
|
||||
Use the `outputTypes` flag to specify the output data format for the search query results. Currently, the only supported output types are `json` and `csv`.
|
||||
|
||||
Here is an example of a `query` command that specifies the `json` output type:
|
||||
Here is an example of a `query` command that specifies the `json` output type:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities
|
||||
@@ -116,10 +115,9 @@ sail search query "name:a*" --indices identities
|
||||
|
||||
#### Folder Path
|
||||
|
||||
Use the `folderPath` flag to specify the folder path to save the search results in.
|
||||
If you don't specify a `folderPath`, the results will save to a folder called "search_results", located within your current working directory.
|
||||
Use the `folderPath` flag to specify the folder path to save the search results in. If you don't specify a `folderPath`, the results will save to a folder called "search_results", located within your current working directory.
|
||||
|
||||
Here is an example of a `query` command that specifies a `folderPath`:
|
||||
Here is an example of a `query` command that specifies a `folderPath`:
|
||||
|
||||
```shell
|
||||
sail search query "name:a*" --indices identities --folderPath ./local/folder/path
|
||||
@@ -129,33 +127,30 @@ 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 Identity Security Cloud.
|
||||
|
||||
### Command
|
||||
|
||||
This example shows the essential `template` command structure:
|
||||
This example shows the essential `template` command structure:
|
||||
|
||||
```shell
|
||||
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 Identity Security Cloud.
|
||||
|
||||
### Flags
|
||||
|
||||
You can append one flag to the `template` command to refine it:
|
||||
|
||||
You can append one flag to the `template` command to refine it:
|
||||
- The flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.
|
||||
|
||||
- The flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.
|
||||
|
||||
#### Folder Path
|
||||
|
||||
Use the `folderPath` flag to specify the folder path to save the search results in.
|
||||
If you don't specify a `folderPath`, the results will save to a folder called "search_results", located within your current working directory.
|
||||
Use the `folderPath` flag to specify the folder path to save the search results in. If you don't specify a `folderPath`, the results will save to a folder called "search_results", located within your current working directory.
|
||||
|
||||
Here is an example of a `template` command that specifies a `folderPath`:
|
||||
Here is an example of a `template` command that specifies a `folderPath`:
|
||||
|
||||
```shell
|
||||
sail search template all-provisioning-events-90-days --folderPath ./local/folder/path
|
||||
```
|
||||
|
||||
|
||||
@@ -6,18 +6,18 @@ sidebar_label: Set
|
||||
sidebar_position: 4
|
||||
sidebar_class_name: cli
|
||||
keywords: ['cli', 'set']
|
||||
description: Learn how to configure your CLI settings in this guide.
|
||||
description: Learn how to configure your CLI settings in this guide.
|
||||
slug: /tools/cli/set
|
||||
tags: ['CLI']
|
||||
---
|
||||
|
||||
## Set
|
||||
|
||||
Learn how to configure your CLI settings in this guide.
|
||||
Learn how to configure your CLI settings in this guide.
|
||||
|
||||
This includes setting your authentication mode, your debug mode, and the filepaths for the templates your CLI uses to make your search and export processes easier.
|
||||
This includes setting your authentication mode, your debug mode, and the filepaths for the templates your CLI uses to make your search and export processes easier.
|
||||
|
||||
You can use these `set` commands to configure your CLI settings:
|
||||
You can use these `set` commands to configure your CLI settings:
|
||||
|
||||
- [Set](#set)
|
||||
- [Auth](#auth)
|
||||
@@ -30,27 +30,27 @@ You can use these `set` commands to configure your CLI settings:
|
||||
|
||||
### Auth
|
||||
|
||||
To set the current authentication method for the CLI, run this command:
|
||||
To set the current authentication method for the CLI, run this command:
|
||||
|
||||
```shell
|
||||
sail set auth {authentication type}
|
||||
```
|
||||
|
||||
You can currently set authentication to either `pat` to use a personal access token (PAT), or `oauth` to use OAuth2 authentication via browser authentication.
|
||||
You can currently set authentication to either `pat` to use a personal access token (PAT), or `oauth` to use OAuth2 authentication via browser authentication.
|
||||
|
||||
### Debug
|
||||
|
||||
To enable debug mode, run this command:
|
||||
To enable debug mode, run this command:
|
||||
|
||||
```shell
|
||||
sail set debug enable
|
||||
```
|
||||
|
||||
To disable debug mode, run the same command with `disable` instead.
|
||||
To disable debug mode, run the same command with `disable` instead.
|
||||
|
||||
### PAT
|
||||
|
||||
To configure PAT authentication for a given environment, run this command:
|
||||
To configure PAT authentication for a given environment, run this command:
|
||||
|
||||
```shell
|
||||
sail set pat
|
||||
@@ -62,7 +62,7 @@ Then follow the prompts to provide your PAT client ID and client secret.
|
||||
|
||||
### Search templates
|
||||
|
||||
To set the filepath for the search templates your CLI uses, run this command:
|
||||
To set the filepath for the search templates your CLI uses, run this command:
|
||||
|
||||
```shell
|
||||
sail set searchTemplates "path/to/search/template/file"
|
||||
@@ -74,14 +74,14 @@ sail set search "path/to/search/template/file"
|
||||
|
||||
#### File format
|
||||
|
||||
Here are a couple examples of the file format a search template uses:
|
||||
Here are a couple examples of the file format a search template uses:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"name": "all-provisioning-events",
|
||||
"description": "All provisioning events in the tenant for a given time range",
|
||||
"variables": [{ "name": "days", "prompt": "Days before today" }],
|
||||
"variables": [{"name": "days", "prompt": "Days before today"}],
|
||||
"searchQuery": {
|
||||
"indices": ["events"],
|
||||
"queryType": null,
|
||||
@@ -111,11 +111,11 @@ Here are a couple examples of the file format a search template uses:
|
||||
]
|
||||
```
|
||||
|
||||
In the first example, the template uses variables in its query. The second example is a fully predefined template without variables.
|
||||
In the first example, the template uses variables in its query. The second example is a fully predefined template without variables.
|
||||
|
||||
### Export templates
|
||||
|
||||
To set the filepath for the export templates your CLI uses, run this command:
|
||||
To set the filepath for the export templates your CLI uses, run this command:
|
||||
|
||||
```shell
|
||||
sail set exportTemplates "path/to/export/template/file"
|
||||
@@ -127,7 +127,8 @@ sail set export "path/to/export/template/file"
|
||||
|
||||
#### File format
|
||||
|
||||
Here is an example of the file format an export template uses:
|
||||
Here is an example of the file format an export template uses:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
|
||||
@@ -6,22 +6,22 @@ sidebar_label: Transforms
|
||||
sidebar_position: 6
|
||||
sidebar_class_name: cli-transforms
|
||||
keywords: ['cli', 'cli transforms', 'transforms']
|
||||
description: Learn about the CLI commands you can use to create, manage, and test transforms in this guide.
|
||||
description: Learn about the CLI commands you can use to create, manage, and test transforms in this guide.
|
||||
slug: /tools/cli/transforms
|
||||
tags: ['CLI']
|
||||
---
|
||||
|
||||
# Transforms
|
||||
|
||||
Learn about the CLI commands you can use to create, manage, and test transforms in this guide.
|
||||
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](/docs/extensibility/transforms).
|
||||
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](/docs/extensibility/transforms).
|
||||
|
||||
With the `transforms` command, it's it easy to create, manage, and test transforms in the CLI.
|
||||
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:
|
||||
To create, manage, and test transforms with the CLI, you can use these commands:
|
||||
|
||||
- [Transforms](#transforms)
|
||||
- [Commands](#commands)
|
||||
@@ -33,13 +33,13 @@ 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:
|
||||
To get a list of the transforms available in your tenant, run this command:
|
||||
|
||||
```shell
|
||||
sail transform list
|
||||
```
|
||||
|
||||
This command produces a table of available transforms.
|
||||
This command produces a table of available transforms.
|
||||
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ By default, this command will save the files in the current working directory. U
|
||||
|
||||
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
@@ -89,9 +89,9 @@ 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.
|
||||
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:
|
||||
This is an example of how you can find a transform ID and delete it:
|
||||
|
||||
```shell
|
||||
sail transform list
|
||||
|
||||
@@ -1,26 +1,28 @@
|
||||
---
|
||||
id: cli-va
|
||||
title: VA
|
||||
title: VA
|
||||
pagination_label: CLI VA
|
||||
sidebar_label: VA
|
||||
sidebar_position: 7
|
||||
sidebar_class_name: cli-va
|
||||
keywords: ['cli', 'va']
|
||||
description: Learn about the CLI commands you can use to interact with VAs in this guide.
|
||||
description: Learn about the CLI commands you can use to interact with VAs in this guide.
|
||||
slug: /tools/cli/va
|
||||
tags: ['CLI']
|
||||
---
|
||||
|
||||
# VA
|
||||
|
||||
Learn about the CLI commands you can use to interact with VAs in this guide.
|
||||
Learn about the CLI commands you can use to interact with VAs in this guide.
|
||||
|
||||
A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in ISC by using APIs, connectors, and other integrations SailPoint has made available.
|
||||
A virtual appliance (VA) is a Linux-based virtual machine that connects to your sources and applications in ISC by using APIs, connectors, and other integrations SailPoint has made available.
|
||||
|
||||
For more information about VAs, refer to the [Virtual Appliance Reference Guide](https://community.sailpoint.com/t5/IdentityNow-Connectors/Virtual-Appliance-Reference-Guide/ta-p/74641?_ga=2.265747530.43742715.1681135659-1245631791.1680185785&_gl=1*1bevvkq*_ga*MTI0NTYzMTc5MS4xNjgwMTg1Nzg1*_ga_SS72Z4HXJM*MTY4MTMwOTc1MC4yOS4xLjE2ODEzMDk5MzkuMjguMC4w).
|
||||
For more information about VAs, refer to the [Virtual Appliance Reference Guide](https://community.sailpoint.com/t5/IdentityNow-Connectors/Virtual-Appliance-Reference-Guide/ta-p/74641?_ga=2.265747530.43742715.1681135659-1245631791.1680185785&_gl=1*1bevvkq*_ga*MTI0NTYzMTc5MS4xNjgwMTg1Nzg1*_ga_SS72Z4HXJM*MTY4MTMwOTc1MC4yOS4xLjE2ODEzMDk5MzkuMjguMC4w).
|
||||
|
||||
## Commands
|
||||
|
||||
To use the CLI to interact with VAs connected to your tenant, run these commands:
|
||||
To use the CLI to interact with VAs connected to your tenant, run these commands:
|
||||
|
||||
- [VA](#va)
|
||||
- [Commands](#commands)
|
||||
- [Collect](#collect)
|
||||
@@ -33,30 +35,31 @@ To use the CLI to interact with VAs connected to your tenant, run these commands
|
||||
- [Flags](#flags-2)
|
||||
- [Example](#example-2)
|
||||
|
||||
### Collect
|
||||
### Collect
|
||||
|
||||
To collect all files from a VA, run this command:
|
||||
To collect all files from a VA, run this command:
|
||||
|
||||
```shell
|
||||
sail va collect {VA IP address} {flags}
|
||||
```
|
||||
```
|
||||
|
||||
This command gets all files from the VA and saves them to the current working directory (the directory you're in), unless you specify flags.
|
||||
This command gets all files from the VA and saves them to the current working directory (the directory you're in), unless you specify flags.
|
||||
|
||||
#### Flags
|
||||
|
||||
You can add these flags to the the `collect` command:
|
||||
- `-o, --output`: Set the path to save the files to. If the directory doesn't exist, the CLI creates it. The default directory is the current working directory.
|
||||
- `-c, --config`: Only get config files.
|
||||
You can add these flags to the the `collect` command:
|
||||
|
||||
- `-o, --output`: Set the path to save the files to. If the directory doesn't exist, the CLI creates it. The default directory is the current working directory.
|
||||
- `-c, --config`: Only get config files.
|
||||
- `-h, --help`: View the command's help with examples within the CLI.
|
||||
- `-l, --logs`: Only get log files.
|
||||
- `-l, --logs`: Only get log files.
|
||||
|
||||
#### Example
|
||||
|
||||
Here is an example command and response:
|
||||
Here is an example command and response:
|
||||
|
||||
```shell
|
||||
sail va collect 10.10.10.25 10.10.10.26 -p S@ilp0int -p S@ilp0int
|
||||
sail va collect 10.10.10.25 10.10.10.26 -p S@ilp0int -p S@ilp0int
|
||||
2023/10/05 22:19:19 INFO Starting File Collection VA=10.10.10.26
|
||||
2023/10/05 22:19:19 INFO Starting File Collection VA=10.10.10.25
|
||||
2023/10/05 22:19:19 WARN Skipping file file=/home/sailpoint/proxy.yaml VA=10.10.10.25
|
||||
@@ -73,40 +76,41 @@ sail va collect 10.10.10.25 10.10.10.26 -p S@ilp0int -p S@ilp0int
|
||||
|
||||
### Parse
|
||||
|
||||
This command converts log files into a human-readable format. It's helpful when you want to troubleshoot VA issues.
|
||||
This command converts log files into a human-readable format. It's helpful when you want to troubleshoot VA issues.
|
||||
|
||||
To parse log files, run this command:
|
||||
To parse log files, run this command:
|
||||
|
||||
```shell
|
||||
sail va parse {log file} {flags}
|
||||
```
|
||||
|
||||
By default, this command parses all errors in the log files, not all log traffic - you can use flags to parse all log traffic.
|
||||
By default, this command parses all errors in the log files, not all log traffic - you can use flags to parse all log traffic.
|
||||
|
||||
#### Flags
|
||||
|
||||
You can add these flags to the `parse` command:
|
||||
- `--type`:
|
||||
You can add these flags to the `parse` command:
|
||||
|
||||
- `--type`:
|
||||
- `canal` Specify that the provided files are Canal log files.
|
||||
- `ccg` Specify that the provided files are CCG log files.
|
||||
- `-e, --everything`: Parse all log traffic, not just errors.
|
||||
- `-h, --help`: View the command's help with examples within the CLI.
|
||||
- `ccg` Specify that the provided files are CCG log files.
|
||||
- `-e, --everything`: Parse all log traffic, not just errors.
|
||||
- `-h, --help`: View the command's help with examples within the CLI.
|
||||
|
||||
#### Example
|
||||
|
||||
Here is an example command:
|
||||
Here is an example command:
|
||||
|
||||
```shell
|
||||
sail va parse --type ccg ./path/to/ccg.log ./path/to/ccg.log --all
|
||||
|
||||
or
|
||||
or
|
||||
|
||||
sail va parse --type canal ./path/to/canal.log ./path/to/canal.log
|
||||
sail va parse --type canal ./path/to/canal.log ./path/to/canal.log
|
||||
```
|
||||
|
||||
### Update
|
||||
|
||||
To update a VA, run this command:
|
||||
To update a VA, run this command:
|
||||
|
||||
```shell
|
||||
sail va update {VA IP address} {flags}
|
||||
@@ -115,16 +119,17 @@ sail va update {VA IP address} {flags}
|
||||
#### Flags
|
||||
|
||||
You can add these flags to the `update` command:
|
||||
|
||||
- `-h, --help`: View the command's help with examples within the CLI.
|
||||
|
||||
#### Example
|
||||
|
||||
Here is an example command:
|
||||
Here is an example command:
|
||||
|
||||
```shell
|
||||
sail va update 10.10.10.25
|
||||
|
||||
or
|
||||
or
|
||||
|
||||
sail va update 10.10.10.25 -p S@ilp0int
|
||||
```
|
||||
|
||||
@@ -13,13 +13,14 @@ tags: ['CLI']
|
||||
|
||||
# Workflows
|
||||
|
||||
Learn how to use the SailPoint CLI to create, manage, and test workflows in this guide.
|
||||
Learn how to use the SailPoint CLI to create, manage, and test workflows in this guide.
|
||||
|
||||
A workflow is a set of steps that are completed whenever a specific event occurs. Once that event triggers the workflow, the workflow performs the steps within Identity Security Cloud.
|
||||
A workflow is a set of steps that are completed whenever a specific event occurs. Once that event triggers the workflow, the workflow performs the steps within Identity Security Cloud.
|
||||
|
||||
The `workflow` command makes it easy to create, manage, and test workflows from within the SailPoint CLI. To learn more about workflows, refer to [Workflows](https://documentation.sailpoint.com/saas/help/workflows/workflow-basics.html?h=workflow).
|
||||
|
||||
- [Workflows](#workflows)
|
||||
|
||||
- [List workflows](#list-workflows)
|
||||
- [Get workflow](#get-workflow)
|
||||
- [Create workflow](#create-workflow)
|
||||
@@ -28,147 +29,147 @@ The `workflow` command makes it easy to create, manage, and test workflows from
|
||||
- [Update workflow](#update-workflow)
|
||||
- [File path](#file-path-1)
|
||||
- [Folder path](#folder-path-1)
|
||||
- [Delete workflow](#delete-workflow)
|
||||
- [Delete workflow](#delete-workflow)
|
||||
- [Download workflow](#download-workflow)
|
||||
- [Folder](#folder)
|
||||
|
||||
## List workflows
|
||||
## List workflows
|
||||
|
||||
To manage workflows in the SailPoint CLI, you need to know which workflows are available, and you may need to know their IDs. Run this command to list the workflows in your tenant:
|
||||
To manage workflows in the SailPoint CLI, you need to know which workflows are available, and you may need to know their IDs. Run this command to list the workflows in your tenant:
|
||||
|
||||
```shell
|
||||
sail workflow list
|
||||
sail workflow list
|
||||
```
|
||||
|
||||
The CLI will return a table of the available workflows in your tenant, with their IDs.
|
||||
The CLI will return a table of the available workflows in your tenant, with their IDs.
|
||||
|
||||
This command uses the [List Workflows endpoint](https://developer.sailpoint.com/docs/api/beta/list-workflows).
|
||||
This command uses the [List Workflows endpoint](https://developer.sailpoint.com/docs/api/beta/list-workflows).
|
||||
|
||||
## Get workflow
|
||||
## Get workflow
|
||||
|
||||
Once you have a workflow's ID, you can see view all its details. Run this command to get a workflow by ID:
|
||||
Once you have a workflow's ID, you can see view all its details. Run this command to get a workflow by ID:
|
||||
|
||||
```shell
|
||||
sail workflow get {workflow ID}
|
||||
```
|
||||
|
||||
Here is an example command:
|
||||
Here is an example command:
|
||||
|
||||
```shell
|
||||
sail workflow get f691874a-c5a5-426d-9dd4-33129072bafa
|
||||
```
|
||||
|
||||
The CLI will return the workflow, along with all its details.
|
||||
The CLI will return the workflow, along with all its details.
|
||||
|
||||
This command uses the [Get workflow endpoint](https://developer.sailpoint.com/docs/api/beta/get-workflow).
|
||||
|
||||
## Create workflow
|
||||
## Create workflow
|
||||
|
||||
To create workflows with the SailPoint CLI, you must append the `--file` (`-f` for short) flag to provide a file path for the workflow. Run this command to create a workflow:
|
||||
To create workflows with the SailPoint CLI, you must append the `--file` (`-f` for short) flag to provide a file path for the workflow. Run this command to create a workflow:
|
||||
|
||||
```shell
|
||||
sail workflow create -f {file path}
|
||||
```
|
||||
|
||||
File paths are relative to the working directory, and only one workflow is allowed per file path. You can provide multiple workflows by specifying multiple file paths as arguments:
|
||||
File paths are relative to the working directory, and only one workflow is allowed per file path. You can provide multiple workflows by specifying multiple file paths as arguments:
|
||||
|
||||
```shell
|
||||
sail workflow create -f {file path} {file-path}
|
||||
```
|
||||
|
||||
Here is an example command:
|
||||
Here is an example command:
|
||||
|
||||
```shell
|
||||
sail workflow create -f ./workflow-file.json
|
||||
```
|
||||
|
||||
Once you create the workflow, it will be located in the file path you specified.
|
||||
Once you create the workflow, it will be located in the file path you specified.
|
||||
|
||||
This command uses the [Create workflow endpoint](https://developer.sailpoint.com/docs/api/beta/create-workflow).
|
||||
This command uses the [Create workflow endpoint](https://developer.sailpoint.com/docs/api/beta/create-workflow).
|
||||
|
||||
### File path
|
||||
### File path
|
||||
|
||||
The first flag you can append when you are creating workflows is required, the `--file` (`-f` for short) flag. This flag specifies the file path for the workflow you are going to create.
|
||||
|
||||
You can specify multiple file paths with one workflow create command.
|
||||
The first flag you can append when you are creating workflows is required, the `--file` (`-f` for short) flag. This flag specifies the file path for the workflow you are going to create.
|
||||
|
||||
You can specify multiple file paths with one workflow create command.
|
||||
|
||||
### Folder path
|
||||
|
||||
The second flag you can append when you are creating workflows is the `--directory` (`-d` for short) flag. Appending the `-d` flag specifies a directory, or folder path, of workflows to contain the created workflow.
|
||||
The second flag you can append when you are creating workflows is the `--directory` (`-d` for short) flag. Appending the `-d` flag specifies a directory, or folder path, of workflows to contain the created workflow.
|
||||
|
||||
Here is what the command looks like with the `-d` flag:
|
||||
Here is what the command looks like with the `-d` flag:
|
||||
|
||||
```shell
|
||||
sail workflow create -d {folder-path}
|
||||
```
|
||||
|
||||
You can also provide multiple workflow directories by specifying multiple folder paths as arguments:
|
||||
You can also provide multiple workflow directories by specifying multiple folder paths as arguments:
|
||||
|
||||
```shell
|
||||
sail workflow create -d {folder-path} {folder-path}
|
||||
```
|
||||
|
||||
## Update workflow
|
||||
## Update workflow
|
||||
|
||||
To update workflows with the SailPoint CLI, you must append the `--file` (`-f` for short) flag to provide a file path for the updated workflow. Run this command to update a workflow:
|
||||
To update workflows with the SailPoint CLI, you must append the `--file` (`-f` for short) flag to provide a file path for the updated workflow. Run this command to update a workflow:
|
||||
|
||||
```shell
|
||||
sail workflow update -f {file-path}
|
||||
sail workflow update -f {file-path}
|
||||
```
|
||||
|
||||
You can also provide multiple workflows by specifying multiple file paths as arguments:
|
||||
You can also provide multiple workflows by specifying multiple file paths as arguments:
|
||||
|
||||
```shell
|
||||
sail workflow update -f {file-path} {file-path}
|
||||
```
|
||||
|
||||
Here is an example command:
|
||||
Here is an example command:
|
||||
|
||||
```shell
|
||||
sail workflow create -f ./workflow-file.json
|
||||
```
|
||||
|
||||
The updated workflow will be located in the file path you specified.
|
||||
The updated workflow will be located in the file path you specified.
|
||||
|
||||
This command uses the [Update workflow endpoint](https://developer.sailpoint.com/docs/api/beta/update-workflow).
|
||||
|
||||
### File path
|
||||
### File path
|
||||
|
||||
The first flag you can append when you are creating workflows is required, the `--file` (`-f` for short) flag. This flag specifies the file path for the workflow you are going to update.
|
||||
|
||||
You can specify multiple file paths with one workflow update command.
|
||||
The first flag you can append when you are creating workflows is required, the `--file` (`-f` for short) flag. This flag specifies the file path for the workflow you are going to update.
|
||||
|
||||
### Folder path
|
||||
You can specify multiple file paths with one workflow update command.
|
||||
|
||||
The second flag you can append when you are updating workflows is the `--directory` (`-d` for short) flag. Appending the `-d` flag specifies a directory, or folder path, of workflows to contain the updated workflow.
|
||||
### Folder path
|
||||
|
||||
Here is what the command looks like with the `-d` flag:
|
||||
The second flag you can append when you are updating workflows is the `--directory` (`-d` for short) flag. Appending the `-d` flag specifies a directory, or folder path, of workflows to contain the updated workflow.
|
||||
|
||||
Here is what the command looks like with the `-d` flag:
|
||||
|
||||
```shell
|
||||
sail workflow update -d {folder-path}
|
||||
```
|
||||
|
||||
You can also provide multiple workflow directories by specifying multiple folder paths as arguments:
|
||||
You can also provide multiple workflow directories by specifying multiple folder paths as arguments:
|
||||
|
||||
```shell
|
||||
sail workflow update -d {folder-path} {folder-path}
|
||||
```
|
||||
|
||||
## Delete workflow
|
||||
## Delete workflow
|
||||
|
||||
To delete workflows with the SailPoint CLI, you must specify the ID of the workflow you want to delete. Run this command to delete a workflow:
|
||||
To delete workflows with the SailPoint CLI, you must specify the ID of the workflow you want to delete. Run this command to delete a workflow:
|
||||
|
||||
```shell
|
||||
sail workflow delete id1
|
||||
```
|
||||
|
||||
You can also delete multiple workflows:
|
||||
You can also delete multiple workflows:
|
||||
|
||||
```shell
|
||||
sail workflow delete id1 id2
|
||||
sail workflow delete id1 id2
|
||||
```
|
||||
|
||||
You can also delete a list of workflows specified in a file:
|
||||
You can also delete a list of workflows specified in a file:
|
||||
|
||||
```shell
|
||||
sail workflow delete $(cat list_of_workflowIDs.txt)
|
||||
@@ -176,22 +177,22 @@ The `workflow` command makes it easy to create, manage, and test workflows from
|
||||
|
||||
This command uses the [Delete workflow endpoint](https://developer.sailpoint.com/docs/api/beta/delete-workflow).
|
||||
|
||||
## Download workflow
|
||||
## Download workflow
|
||||
|
||||
To download workflows with the SailPoint CLI, run this command:
|
||||
To download workflows with the SailPoint CLI, run this command:
|
||||
|
||||
```shell
|
||||
sail workflow download
|
||||
sail workflow download
|
||||
```
|
||||
|
||||
Running this command downloads the available workflow files to the default folder, "workflows".
|
||||
Running this command downloads the available workflow files to the default folder, "workflows".
|
||||
|
||||
### Folder
|
||||
### Folder
|
||||
|
||||
By default, workflows downloaded from the CLI are located in the folder, "workflows". To change the folder the workflows are downloaded to, append the `-f` flag to the command, as shown in this example:
|
||||
By default, workflows downloaded from the CLI are located in the folder, "workflows". To change the folder the workflows are downloaded to, append the `-f` flag to the command, as shown in this example:
|
||||
|
||||
```shell
|
||||
sail workflow download -f my-workflows
|
||||
```
|
||||
|
||||
Running this command downloads the available workflow files.
|
||||
Running this command downloads the available workflow files.
|
||||
|
||||
Reference in New Issue
Block a user