diff --git a/docs/tools/cli/index.md b/docs/tools/cli/index.md index 961aed3ffa8c5..af1a3cf3c1ac6 100644 --- a/docs/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -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 diff --git a/docs/ui-plugins/create-a-plugin-instance.md b/docs/ui-plugins/create-a-plugin-instance.md index 573195a1720e2..2d181c385cbd0 100644 --- a/docs/ui-plugins/create-a-plugin-instance.md +++ b/docs/ui-plugins/create-a-plugin-instance.md @@ -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` @@ -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: diff --git a/docs/ui-plugins/img/navbar-add-sub-menu-item.png b/docs/ui-plugins/img/navbar-add-sub-menu-item.png new file mode 100644 index 0000000000000..3098af3d9f072 Binary files /dev/null and b/docs/ui-plugins/img/navbar-add-sub-menu-item.png differ diff --git a/docs/ui-plugins/img/navbar-plugin-destination.png b/docs/ui-plugins/img/navbar-plugin-destination.png new file mode 100644 index 0000000000000..253b765530c8c Binary files /dev/null and b/docs/ui-plugins/img/navbar-plugin-destination.png differ diff --git a/src/pages/hack-day/saas-connectivity.mdx b/src/pages/hack-day/saas-connectivity.mdx index 306082b5220d5..3b9e67d1bc2f8 100644 --- a/src/pages/hack-day/saas-connectivity.mdx +++ b/src/pages/hack-day/saas-connectivity.mdx @@ -41,7 +41,9 @@ If that prints anything below 18, grab a current release from [nodejs.org](https ```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 ``` diff --git a/src/pages/hack-day/ui-plugins.mdx b/src/pages/hack-day/ui-plugins.mdx index e60d27db3bc44..daf9ffdcdaa0d 100644 --- a/src/pages/hack-day/ui-plugins.mdx +++ b/src/pages/hack-day/ui-plugins.mdx @@ -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 ```