Steps to re-create embedded connector in vIDM

Products

• VMware Aria Suite

Issue/Introduction

Creating/Adding an embedded or Internal connector in vIDM UI.

Environment

VMware Identity Manager 3.3.x

Cause

If the connector was accidentally removed or deleted in VMware Identity Manager, it needs to be restored and activated through the API. This article outlines the steps to obtain the necessary tokens, activate the connector, and integrate it within the VMware Identity Manager

Resolution

NOTE: Ensure to take a snapshot of all the vIDM nodes. Before proceeding with the below steps:

Generate an Activation Code for the VMware Identity Manager Connector
Log in to the VMware Identity Manager console as the System domain admin. and We need to use the Post man script  to activate the embedded connector when re-adding using below steps.

1. Click the Identity & Access Management tab. Click Setup.
2. On the Connectors page, click Add Connector.

3. Enter a name for the connector. Click Generate Activation Code. The activation code displays on the page. Copy the activation code and save it.

 

4. Once you have the activation code generated from the above pop-up, you can use below request to activate the connector.

Step 1 : Open postman or rest client and run below APIPOST. Follow below steps to acquire the HZN token.

• Make a post request to below link
  • URL: https://<VIDM Node FQDN>/SAAS/API/1.0/REST/auth/system/login

  • Method: POST
    Headers:
    Accept: application/json; charset=utf-8
    Content-Type: application/json
    
    Example Request Body:
    {
        "username": "admin",
        "password": "adminpassword",
        "issueToken": "true"
    }
    
    Example Response
    {
        "id": null,
        "sessionToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJlYTY4ZWQ0NC1mYWYwLTQ5OWEtYTk5Yi0xMWI4YzBiZDZlZjgiLCJwcm4iOiJhZG1pbkBTVkEiLCJkb21haW4iOiJMb2NhbCBVc2VycyIsInVzZXJfaWQiOiIyIiwiYXV0aF90aW1lIjoxNDM1MDI1NDY2LCJpc3MiOiJodHRwczovL2d3LWFhLmhzLnRyY2ludC5jb20vU0FBUy9BUEkvMS4wL1JFU1QvYXV0aC90b2tlbiIsImF1ZCI6Imh0dHBzOi8vZ3ctYWEuaHMudHJjaW50LmNvbSIsImN0eCI6Ilt7XCJtdGRcIjpcInVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDphYzpjbGFzc2VzOlBhc3N3b3JkUHJvdGVjdGVkVHJhbnNwb3J0XCIsXCJpYXRcIjoxNDM1MDI1NDY2LFwiaWRcIjo0fV0iLCJzY3AiOiJwcm9maWxlIGFkbWluIHVzZXIgZW1haWwgb3BlcmF0b3IiLCJpZHAiOiIwIiwiZW1sIjoiYWRtaW5Adm13YXJlLmNvbSIsImNpZCI6IiIsImRpZCI6IiIsIndpZCI6IiIsImV4cCI6MTQzNTA1NDI2NiwiaWF0IjoxNDM1MDI1NDY2LCJzdWIiOiJmZjkxYWI0Zi1mZDg3LTRjZjgtODNlMS04ZTEyMTA5YTkzODgiLCJwcm5fdHlwZSI6IlVTRVIifQ.nTMNBGg_vqPB-2VBWW2YzThprrURLBjjjlF8nSM8LYS8RDlhW49ht0hjWvnLSTmboGo160BWJs1BgCaHSe1Uwj5Mqv4K05_VsfrKkvCOGtikjCZvJ8u4dz9zRxfofOeKtfH5jtX9AUjZQoVjgYAwkXd8WNE9Ax9r5QIk06zmxaI",
        "firstName": null,
        "lastName": null,
        "admin": false
    }

Once acquired the HZN Token follow below steps.

Step 2 : Activate Connector using Activation Token

POST https://<connectorHost>:8443/hc/API/1.0/REST/connectormanagement/connector/activate/

 

Headers:

Content-Type:  application/vnd.vmware.horizon.manager.connector.management.activate.connector+json

Authorization: HZN <token> obtained from step1

 

Body

{

"activationToken":"<connector_activation_code>",

"adminPassword":"<adminpassword>",

"gatewayHostname":"<host_name/LB_FQDN>"

}

Success Response Status : 200 OK

Sample Response

{

"isSuccess":true,

"redirectUrl":"<connector worker URL>",

"message":"Successfully activated the Connector.",

"tenantStateId":{"tenant":"<Tenant Id>","connector":"<connector worker Id>"}

}

Additional Information

Upon successful execution, a 200 response code will be returned

The connector will now be visible in the Admin UI

Complete the integration by adding the connector under workspace_IDP for directory connection or authentication in the Admin UI.