/vscode-sailpoint-iiq

A Visual Studio Code extension that helps developers accelerate their interactions with SailPoint IdenityIQ

Primary LanguageTypeScriptMIT LicenseMIT

vscode-sailpoint-iiq icon

VSCode SailPoint IdentityIQ Extension

GitHub package.json version GitHub top language Snyk Vulnerabilities for GitHub Repo

This is the README for the vscode-sailpoint-iiq visual studio code extension. With this extension you will be able to communicate directly with your IdentityIQ server from within vscode!

Requrirements

In order to use this extension, you will need a running a SailPoint IdentityIQ instance and you will need to have the appropriate permissions to create and update workflows and access the REST API. Today, that requires that you are an admin within your instance.

Prerequirement

We use the workflow REST APIs in order to communicate with your IdentityIQ environment. In order to call the appropriate workflow, with the methods we use for this extension, you will need to import the workflow into your environment.

  • An initial import of the ./media/VSCodeExtgensionWF.xml file in order for this extension to interact with your IdentityIQ server. After this initial import is completed, this extension can update the workflow whenever an newer version has been released.

Features

The following features have been implmented into this extension. Additional features will be added as time permits.

Commands:

  • Publish File will publish the currently active text document to your IdentityIQ environment. If you are using a Services Standard Build (SSB) project, this will replace the tokens with the appropriate environment you have enabled.

  • Run Task allows you to run a task on your IdentityIQ environment. This may be with or without any parameters

  • Run Rule allows you to run a rule on your IdentityIQ environment. If an argument is expected the currently active text document will be evaluated using the SST layout; if no match is found an input will allow you to provide the argument.

  • Evaluate Beanshell Script will execute in your IdentityIQ environment the code you've seleted.

    • In order to observe the results, ensure that you include a return statement.
    • After execution is complete, the results will be presented by a virtual document.
    • You can also check your log file.

  • Switch Environment allows you to switch between multiple *.target.properties files.

    • Ensure your *.target.properties document includes the %%ECLIPSE_URL%% token, this will be used to tell the extension which URL to communicate with.
    • Do not include the following tokens as they will be ignored: %%ECLIPSE_USER%% and %%ECLIPSE_PASS%%

  • Compare with Server will open a comparison between your local copy of a file and what is currently deployed within your IdentityIQ environment.

User Interface:

  • IdentityIQ Activity View will show you all the objects currently deployed in your IdentityIQ environment. From there, you can download the entire category or individual objects. If you're using SSB, the documents will be downloaded and values replaced with the tokens found in your projects current selected environment *.target.properties file.

  • Status Indicator will show the currently selected environment, the username used to connect to your IdentityIQ server and provide some information about the server you're communicating with.

  • Syntax Highlighting will be used within your beanshell documents. Your Java code will be colorized within your XML+beanshell documents.