Skip to main content

UI Development Kit

Overview​

The SailPoint UI Development Kit is a project you can use to develop custom user interfaces that interact with Identity Security Cloud (ISC).

The UI Development Kit provides you with a framework you can use to build your own applications or processes on the ISC platform.

Read this guide to learn how to use the SailPoint UI Development Kit.

Requirements​

These are the requirements to use the UI Development Kit:

  • Node: To learn how to download and set up Node, go here.

  • Angular: To learn how to install and set up Angular, go here.

  • TypeScript. Use npm to install TypeScript globally, meaning that you can use the tsc command anywhere in your terminal. To do so, run this command:

npm install -g typescript
  • Your ISC tenant name. To find your ISC tenant name, refer to Getting Started. The UI Development Kit uses your tenant name to connect to your ISC instance.

Clone the project​

To set up the UI Development Kit, clone the project from its GitHub repository.

To clone the project, run this command:

git clone https://github.com/sailpoint-oss/ui-development-kit.git

Project structure​

This project is built on Angular and builds an Electron application.

Setting up the project is simple. The environment and application building process are configured so that you can start creating custom UIs immediately. However, it is still helpful to understand the project structure.

Most of your activity will involve the projects/sailpoint-components folder, such as adding new components and css styles. You can learn more about these processes in Getting Started.

This is the basic project structure:

.
├── projects/
│   └── sailpoint-components/
│       └── src/
│           ├── package.json
│           └── All shared custom components will live here
├── src/
│   └── app/
│       ├── app.component.html
│       ├── app.component.scss
│       ├── app.component.spec.ts
│       ├── app.component.ts
│       ├── app.module.ts
│       └── app.routes.ts
├── package.json
├── angular.json
└── electron-builder.json

Run the application for local development​

To run and develop the project locally, follow these steps:

  1. In the root of the project, run this command to install dependencies:

    npm install

  2. To start the application, run this command:

    npm run start

Get started​

To learn how to use the UI Development Kit and explore its possibilities, refer to Getting Started.

Getting support​

For support, refer to our GitHub page.

To submit a bug report, click here.

To submit a feature request, click here.

Contribute​

Do you have an idea to help improve the UI Development Kit? You can contribute directly.

Before contributing, you must sign our CLA and read the Contribution Guidelines.

Discuss​

The most valuable resource for ISC developers is the SailPoint Developer Community itself, where ISC users and experts all over the world come together to ask questions and provide solutions.

To learn more about the ISC UI Development Kit and discuss it with SailPoint Developer Community members, go to the SailPoint Developer Community Forum.