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
18 changes: 16 additions & 2 deletions docs/tools/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,24 @@ To install the MSI file, double click on it and follow the prompts in the instal
MacOS users can use [Homebrew](https://brew.sh/) to install the CLI. Run these commands in your terminal:

```bash
brew install sailpoint-oss/tap/sailpoint-cli
brew tap sailpoint-oss/tap
brew trust --formula sailpoint-oss/tap/sailpoint-cli
brew install sailpoint-cli
```

Then make sure you can run the `sail` command.
Homebrew does not load formulas from unofficial taps until you trust them. If you skip the `brew trust` command, the install fails with this error:

```text
Error: Refusing to load formula sailpoint-oss/tap/sailpoint-cli from untrusted tap sailpoint-oss/tap.
```

You only need to trust the formula once. To trust every formula in the tap instead, run `brew trust sailpoint-oss/tap`.

Then make sure you can run the `sail` command:

```bash
sail --version
```

### Linux

Expand Down
28 changes: 25 additions & 3 deletions docs/ui-plugins/create-a-plugin-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ pagination_label: Create a Plugin Instance
sidebar_label: Create a Plugin Instance
sidebar_position: 2
sidebar_class_name: uiPluginsCreate
keywords: ['ui', 'plugins', 'ui-plugins', 'create', 'init', 'link', 'upload', 'cors', 'chrome', 'troubleshooting']
description: Scaffold, register, develop, and deploy your first UI plugin with the SailPoint CLI.
keywords: ['ui', 'plugins', 'ui-plugins', 'create', 'init', 'link', 'upload', 'cors', 'chrome', 'troubleshooting', 'navbar', 'nav bar']
description: Scaffold, register, develop, deploy, and add your first UI plugin to the nav bar with the SailPoint CLI.
slug: /ui-plugins/create-a-plugin-instance
tags: ['ui-plugins']
---

This walkthrough takes you from an empty directory to a UI plugin running in your Identity Security Cloud (ISC) tenant. You will scaffold a workspace, register a plugin instance, load your locally running code inside ISC, and finally deploy compiled assets.
This walkthrough takes you from an empty directory to a UI plugin running in your Identity Security Cloud (ISC) tenant. You will scaffold a workspace, register a plugin instance, load your locally running code inside ISC, deploy compiled assets, and add the plugin to the ISC nav bar.

## Step 1: Scaffold a workspace with `init`

Expand Down Expand Up @@ -252,6 +252,28 @@ The workspace `alias` is the deterministic lookup key for the plugin instance, s

:::

## Step 7: Add the plugin to the nav bar

After you upload the plugin, users can open it only from its URL. A nav bar item gives the plugin a permanent place in ISC, next to the standard menus.

1. In your tenant, go to **Admin → Global → System Settings → Customize Navbar**.
2. Open **Custom Item**, and select the **Enabled** checkbox.
3. For **Language**, keep **English**. You can enter additional languages if desired. For **Label**, enter the name of the top menu, for example `Test Plugin`.
4. Click **Add sub menu item**.

![The Custom Nav Item page, with a label and the Add sub menu item button](./img/navbar-add-sub-menu-item.png)

5. In the dialog, enter the name of the item inside the menu as the **Label**, for example `Test Plugin Page`.
6. For **Destination**, select **Plugin**. Then select `test-plugin` in the **Plugin** list.
7. Leave **Required Capabilities** empty to show the item to every user. To show the item to only one audience, select a capability.
8. Click **Done**.

![The Add sub menu item dialog, with the plugin destination selected](./img/navbar-plugin-destination.png)

9. Click **Save**.

Refresh your tenant. The nav bar shows the **Test Plugin** menu, and the menu contains **Test Plugin Page**. Click the item to open your plugin inside ISC.

## Manage your plugins

List every plugin instance registered in the current tenant:
Expand Down
Binary file added docs/ui-plugins/img/navbar-add-sub-menu-item.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion src/pages/hack-day/saas-connectivity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ If that prints anything below 18, grab a current release from [nodejs.org](https
<TabItem value="macos" label="macOS" default>

```bash
brew tap sailpoint-oss/tap && brew install sailpoint-cli
brew tap sailpoint-oss/tap
brew trust --formula sailpoint-oss/tap/sailpoint-cli
brew install sailpoint-cli
```

</TabItem>
Expand Down
4 changes: 3 additions & 1 deletion src/pages/hack-day/ui-plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ version.
**Your terminal**

```bash
brew tap sailpoint-oss/tap && brew install sailpoint-cli
brew tap sailpoint-oss/tap
brew trust --formula sailpoint-oss/tap/sailpoint-cli
brew install sailpoint-cli
```

</TabItem>
Expand Down
Loading