Skip to main content

Cloud Connector On-Boarding Guide

Purpose of the document​

The document provides a detailed guide on using the IDHub’s Cloud Connector On-Boarding Wizard

Who can use this​

The guide is primarily for those people who will like to use IDHub hosted connector which is managed by IDHub.

Steps to follow to deploy the Cloud Connector​

Pre-Requisites​

  • You would need a IDHub Cloud Subscription before you can deploy Atlassian Cloud Connector. For detailed steps of getting IDHub Cloud subscription, Click Here
  • Go to the sath website and at the top navigation menu under Product go to Identity Connectors and then click on the connector that you want to deploy
  • Then you will be taken to the Cloud connector details page. Click on the button deploy in the cloud

Pick a Connector​

Select the connector from Pick a Connector drop-down. Then you enter the name of the connector. This connector name will help you identify the connector. Click on the Add to Cart button.

Checking out​

In the next step, you will be taken to the the checkout page: Click on the Checkout order button, then you will be taken to the next page asking you to enter your contact details and billing address details. If you are visiting this page for the 1st time, then you will have to enter the required information. Next time, the information would be auto-filled in this page. Next you will be shown the order confirmation page. Click on the Account Management link in thar page to proceed.

Account Management​

Clicking on the Account management link will take you to your account management dashboard. From the left menu click on the Connectors. In the connectors page, this will show you the complete list of all connectors that you have deployed in your tenant along with it's health status. If you have not yet deployed the connector, it would be shown as Not configured.

Goto Connector Manager​

  • Click on the 3 dots menu for the connector and then click on the Manager Menu.
  • You will be taken to the IDHub Connector manager page

Connector Manager page​

  • Here you will have to enter the application URL and the tenant name. The application URL is the IDHub application URL for example: https://app.sath.com
  • Now click on the REGISTER button in order to proceed further.

IDHub Tenant Login and tenant verification​

You will then be redirected to your tenant login and would be asked to login to your tenant (if not already done so). Once the tenant login is verified you will be taken to the next page,

Connector Information page​

This page shows the following information:

  • Connector type
  • Connector health
  • IDHub info
    - Application URL
    - Connector tenant
    - Onboard Application
    Now click on the Onboard now link to proceed further

Enter the Application Credentials​

The next screen set-up will ask you to enter the credentials for your target system instance. Different connectors have different credentials and setups that you need to do at the target system, before you can onboard that connector in IDHub. Please refer to the individual connector guide in order to find out the pre-requisites for deploying the connector.

After adding the required target system configuration details and you need to click on Apply button and then click on the NEXT button. Now you will be shown the account and entitlement JSON file in the editor.

note
  • Account JSON file contains the default settings used to fetch and provision accounts using specific attributes. You can modify these default settings as needed
  • Entitlement JSON file contains the default settings used to fetch and provision entitlements using specific attributes. You can modify these default settings as needed

Click on the next button and you will be shown a scratchpad. You can edit this file to jot down notes, reminders, or any information you may need for future reference. Now click on the next button and then click on the ONBOARD button. This will start the onboarding of the connector and once finished

On-Board Application​

This is the last step, where you will be asked to enter the application name (that would be shown in IDHub). Also there would be options where you can check whether you would like to make the application as Trusted application. And you have the option to check, if you would like to create a certification automatically which would check the access permissions in your atlassian cloud application. Now click on the SUBMIT button After successfully onboarding the application, you will be redirected to the connector information page with connection status as UP

Ending Notes​

If you have any questions or concerns, or if there are areas you wish to explore further, please feel free to reach out here. Your feedback is incredibly valuable, not only in improving these resources, but also in helping to shape future content.