EN
Español
English
Português
    TenantIds and uniqueTenant

    Tenants de HP TechPulse

    TechPulse APIs require unique company, device, and user identifiers of type GUID, these identifiers can be obtained using the following endpoint:

    GET /analytics/v1/identity/tenants
    

    Getting the following answer

    {
        "schemas": [
            "urn:scim:schemas:core:2.0:Tenant"
        ],
        "id": "tenant-uuid-1",
        "displayName": "Customer Name",
        "description": "",
        "tenantType": "CUSTOMER",
        "subTypes": [],
        "phoneNumber": {
            "value": "555-5555",
            "type": "work"
        },
        "ownerId": "test-emailid@email.com"
        ....
    }
    


    Note: This request was made in authentication to obtain the refresh-token.


    For more tenant information, see the HP TechPulse documentation View HP TechPulse documentation

    • Add the “ID” in the configuration file as follows:

      Take the Id from the answer obtained above and write in the sections of “uniqueTenant” (Client type tenant)

          {
            "tenantIds": [
            ],
            "uniqueTenant": "tenant-uuid-1",
            "mappers": [
              {
                "id": "",
                "subtypes": [
      
                ],
                "tenantIds": [
                  "tenant-uuid-1"
                ],
                "filter": "",
                "case": {
                  "caseType": 0,
                  "project": 0,
                  "service": 0,
                  "category": 0,
                  "group": 0,
                  "registryType": 0,
                  "state": [
      
                  ],
                  "sla": 0,
                  "company": 0,
                  "urgency": [
      
                  ]
                }
              }
            ],
            "companies": [
            ]
          }    
    

    Associated tenants:

    Client-type tenants can have partners “tenants” of device and/or company type. To get the identifiers, see the following API:

    GET /analytics/v1/identity/tenants/children
    


    Note: The authentication type is OAuth 2.0


    Getting the following answer

    {
      "schemas": [
        "urn:scim:schemas:core:2.0:ListResponse"
      ],
      "totalResults": 7,
      "startIndex": 0,
      "itemsPerPage": 7,
      "resources": [
        {
          "id": "tenant-uuid-children-1",
          "displayName": "Children 1",
          "type": "CUSTOMER",
          "ownerId": "xxx",
          "status": "Active",
          "subscriptionState": "OVER_ENROLLED",
          "owner": {
            "..."
          },
          "parents": [
            {
              "id": "tenant-uuid-parent-1",
              "association": "xxxx",
              "name": "xxx xxx",
              "primaryAdministrator": {
                "xxxx"
              }
            },
            "..."
          ],
          "subTypes": [
            null,
            null
          ],
          "lastImpersonatedOn": "2020-11-27 16:39:43 UTC",
          "impersonatedBy": "xxxx-xxxx-xxxx-xxxx"
        },
        "..."
      ]
    }
    
    • Add the associated tenants in the configuration file as follows:

      Take the Id of the resources in the answer obtained above and write in the sections of “tenantIds” (client, device, and company type tenants):

          {
             "tenantIds":[
                "tenant-uuid-children-1"
             ],
             "uniqueTenant":"tenant-uuid-1",
             "mappers":[
                {
                   "id":"",
                   "subtypes":[
          
                   ],
                   "tenantIds":[
                     "tenant-uuid-children-1"
                   ],
                   "filter":"",
                   "case":{
                      "caseType":0,
                      "project":0,
                      "service":0,
                      "category":0,
                      "group":0,
                      "registryType":0,
                      "state":[
      
                      ],
                      "sla":0,
                      "company":0,
                      "urgency": [
      
                      ]
                   }
                }
             ],
             "companies": [
             ]
          }
    

    Configure partner tenants in integration file

    Tenant Global

    The configuration allows the integration of one or more clients for different configurations of cases in Asdk, this type of integration will be done by the following configuration:

    
    {
      "tenantIds": [
        "tenant-uuid-children-1"
      ],
      "uniqueTenant": "tenant-uuid-1",
      "mappers": [
        {
          "id": "",
          "subtypes": [
            ""
          ],
          "filter": "",
          "case": {
            "caseType": 0,
            "project": 0,
            "service": 0,
            "category": 0,
            "group": 0,
            "registryType": 0,
            "state": [
              {}
            ],
            "sla": 0,
            "company": 0,
            "urgency": [
    
            ]
          }
        }
      ],
      "companies": [
      ]
    }    
    
    

    Unique company, device, and user identifiers are aggregated globally in the “tenantIds” allowing you to filter incidents from Hp TechPulse and import them into the ASDK.


    Tenant Specific

    The configuration allows the integration of one or more clients for a single Asdk project, this type of integration will be done by the following configuration:

    {
      "uniqueTenant": "tenant-uuid-1",
      "mappers": [
        {
          "id": "",
          "subtypes": [
            ""
          ],
          "tenantIds": [
            "tenant-uuid-children-1"
          ],
          "filter": "",
          "case": {
            "caseType": 0,
            "project": 0,
            "service": 0,
            "category": 0,
            "group": 0,
            "registryType": 0,
            "state": [
    
            ],
            "sla": 0,
            "company": 0,
            "urgency": [
    
            ]
          }
        }
      ],
      "companies": [
      ]
    }
    

    Unique company, device, and user identifiers are added in the “tenantIds” allowing each company, device, and user to have a unique configuration when creating cases in Asdk.

    Considerations:

    • Configuration with Specific tenants takes precedence over the configuration of the Global Tenants, if the case arises that you have the “tenantIds” in a specific and global way, the system gives priority to the specific ones, ignoring the tenants aggregated globally.
    • If the property is not added tenantIds (global or specific), the system takes as a reference the property uniqueTenant.*


    ↩ Return