npm package: @itentialopensource/test-iap-connectivity
Description: Test IAP REST connectivity to south bound systems such IAG/NSO
Author: Itential Artifacts
Latest version: 0.0.9-2023.1.0

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your artifact name -->
# Test IAP Connectivity

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [Requirements](#requirements)
* [Features](#features)
* [Future Enhancements](#future-enhancements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview
This artifact enables you to test IAP REST connectivity to south bound systems such IAG/NSO.
It is currently set for GET, but can be easily changed to POST. Additionally, it can be used for IAP environments that are not easily accessible such as IAP in Cloud.
This artifact is built to skip the authorization step from adapters and allow IAP to "see" the login for south bound systems.
<!-- Write a few sentences about the artifact and explain the use case(s) -->
<!-- Ex.: The Migration Wizard enables IAP users to conveniently move their automation use cases between different IAP environments -->
<!-- (e.g. from Dev to Pre-Production or from Lab to Production). -->

<!-- Workflow(s) Image Placeholder - TO BE ADDED DIRECTLY TO GitLab -->
<!-- REPLACE COMMENT BELOW WITH IMAGE OF YOUR MAIN WORKFLOW -->
<table><tr><td>
  <img src="./images/workflow.png" alt="workflow" width="800px">
</td></tr></table>

The following examples show test IAP connectivity to IAG.

<table><tr><td>
  <img src="./images/IAG-IAPconnection.png" alt="IAG-IAPconnection" width="800px">
</td></tr></table>

<table><tr><td>
  <img src="./images/Connection-success.png" alt="Connection-success" width="800px">
</td></tr></table>

Similarly, the example below shows test IAP connectivity to NSO.

<table><tr><td>
  <img src="./images/NSO-IAPconnection.png" alt="NSO-IAPconnection" width="800px">
</td></tr></table>

This example shows the dialog for an unsuccessful connection.

<table><tr><td>
  <img src="./images/connection-unsuccessful.png" alt="NSO-IAPconnection" width="800px">
</td></tr></table>


<!-- REPLACE COMMENT ABOVE WITH IMAGE OF YOUR MAIN WORKFLOW -->

<!-- ADD ESTIMATED RUN TIME HERE -->
<!-- e.g. Estimated Run Time: 34 min. -->
_Estimated Run Time_: Usually within minutes.

## Installation Prerequisites

Users must satisfy the following pre-requisites:

* Itential Automation Platform
  * `^2023.1`

## Requirements

This artifact currently has no additional requirements.

## Features

The main benefits and features of the artifact are outlined below.

* Establishes successful IAP connectivity with IAG/NSO using GET.

## Future Enhancements

No future enhancements have been identified at this time.

## How to Install

To install the artifact:

* Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the [Requirements](#requirements) section. 
* The artifact can be installed from within **App-Admin_Essential**. Simply search for the name of your desired artifact and click the install button.

## How to Run

To run the artifact:

* Navigate to the appropriate Automation Catalog entry and run manually.
* Complete all fields and then submit.