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.
- Using the Cloud connector is chargeable. IDHub provides 30 days free trial of the vault subscription. After the trial expiry it will be charged on a monthly basis.
- For On-Prem scenarios, follow the steps for installing the connector using the steps outlined in the connector guide here
What you will learn in the document
What are the Pre-Requisites
Where are the Secrets Stored
Pick a connector
Pick a Tenant
Add your application credentials
Verify & Install
On-Board Application
Ending Notes
What are the Prerequisites?
You would need a IDHub Cloud Subscription. For detailed steps of getting IDHub Cloud subscription, Click Here
- Go to the sath website and at the top navigation menu go to identity connectors and then click on the desired connector that you would like to on-board.
- Then you will be taken to the connector details page. Click on the button
deploy in the cloud. - You will be redirected to the IDHub connector onboarding wizard.
What are the secrets stored?
IDHub needs to store the secret in a secure vault, so that the data can be transferred securely between IDHub and the target system and vice-versa. IDHub is storing the secrets for the connector via HashiCorp. We are providing a free 30 trial period of Vault Subscription. If you already have your own Vault then you can also your own Vault and connect to that for storing secrets.
IDHub will soon release in-house vault service using which you can use to store secrets within IDHub’s own vault without purchasing additional vault subscription.
Pick a Connector
At this point you will have to select the connector that you want to onboard. You can select your desired connector from the dropdown. Then you enter the name of the connector. This connector name will help you identify the connector. Click on the next button.
Pick a Vault
This is the Pick a vault page. Here you can either create a new vaucredslt or you can use the external vault (If you already have a vault subscription).
Once the Create new vault button is clicked. A pop-up window will open, where you need to enter the vault name. Click on the get vault button after entering the vault name.
Another pop-up window will open, and it will show the unseal key and the root token creds for the vault. A file with the credentials for the vault will also be automatically downloaded. Keep this in a safe place for future reference and integrations with other applications. Click on the done button.
At this stage, click on the choose link and it will display the setup vault pop-up window. Here the root token will be automatically populated since this is the first time setup. Subsequent setups will require you to enter your root token creds for the vault. Click on the setup button.
Pick a Tenant
In the next screen, you will have to select the tenant where the connector will be installed.
If you do not have a IDHub subscription, then the setup will first ask you to get a IDHub subscription before you can proceed with the setup.
You select the tenant from the drop-down and click on the button Verify Tenant. Please make sure that you have the admin credentials of your tenant to proceed with the next steps.
Now another pop-up window will appear and it will ask you to enter your admin creds for the tenant.
If you are already logged into your IDHub tenant, the setup will verify the tenant and the pop-up window will automatically close.
Add your 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. You can click on the documentation link at the bottom of the screen to get more information about how to set up your target system and get these credentials.
After adding the required target system configuration details and you need to click on the set-up vault button in order to proceed further. Setup will then automatically download the RoleID and secretID of the which will help you to log into your connector manager system. After this, click on the next button to proceed to the next step.
Verify & Install
This is the confirmation page and displays the installation details of the connector. Click on the agree to terms checkbox and then click on the button install now. The setup will then take some time to install the connector.
Once the connector is installed successfully and is ready to use, a button is displayed to onboard the application. This is the optional step. This enables you to on-board the target system application to your tenant from the set-up. Click on the On-board App button to proceed.
On-Board Application
In this screen enter the name of the application. If you want to get users from your target system instance to IDHub then you can click on the checkbox below as well. All users with unique email addresses will be added to IDHub. Now click on the ADD now button. Setup will take some time and display the confirmation message. Finally, the target system connector is successfully installed and optionally your target system application is also onboarded to IDHub.
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.