Connections

Connections

Connections are used to authenticate AssetExplorer Cloud integrations with external applications. You can use connections inside custom functions to invoke REST APIs of any third-party applications.

Benefits of Connections  

  1. Prevents exposure of a user's authentication token to other users in the application.
  2. Handles dynamic token generation (refresh tokens)
  3. Invoke REST APIs of third-party applications.
  4. You can set up connections with default or custom services.

 

If you are using a custom domain, ensure that it is HTTPS enabled to access Connections.

 

 Connections for Default Services   

The application provides default connections with many services, such as Zoho, Google, Hubspot, Trello, etc. To set up connections for default services,

  1. Go to Setup > Developer Space > Connections.
  2. Click Create Connection.
  3. Pick Your Service - Select a service.
  4. Connection Details - Provide a name for the connection and a link name to identify the connection.
  5. Use Credentials Of Login User - Enable this option to allow users to authorize the connection in custom widgets individually. If the option is disabled, only the administrator who created the connection can authorize it using their own tokens.

The Use Credentials Of Login User option is relevant only to custom widgets. If a connection is independent of custom widgets, this configuration will not be accounted by AssetExplorer Cloud and only administrators are allowed to authorize connections.

  • Scopes - Select access permissions to be authorized for the connection.

Scope access permissions are defined by third-party services. We recommend checking their documentation to understand the scopes they provide.

  • Click Create and Connect.

</SS>

The connection will be created and displayed with the following fields and a code snippet.

  • Link Name: The name provided for the connection.

  • Scopes: The account authorized through connection will have access to the URLs displayed under Scopes.

  • ServiceName: Name of the third-party application.

  • Status: Indicates the connection status.

</SS>

  • Click Done, and you will be redirected to the connections home page.

  • To set up the created connection, hover over the connection and click Connect.

</SS>

  • Sign in to the third-party application and authenticate AssetExplorer Cloud. The connection will be activated.

  • You can use the code snippet provided for the connection in custom functions.

If you are using a custom domain, ensure that it is HTTPS enabled to access Connections.

 

Using Connections   

Click a Connection on the Connections home page to view the code snippet.
Copy the Deluge code snippet to a custom function and proceed as follows:
  1. Replace <url> with the URL to be invoked.

  2. Choose the HTTP method.

  3. Pass parameters, if any.

You can add connections to custom widgets by copying the JSON code snippet to a custom widget package. Use the pointers for reference:

  • Add line breaks after each property in the JSON object.

  • You can set the "userAccess" as "true" to allow users to authorize connections individually. To restrict authorization to only administrators, set "userAcess" as "false".

Click here to learn more about adding connections to custom widgets.

 

List View Operations   

On this page, you can set up, revoke, and delete connections.

  • Click Add Connection to create a connection with default or custom services.

  • To set up a connection, click Connect.

  • View the code snippet of each connection (both active and revoked) by simply clicking the connection name.

  • Modify the name and scope of a connection by using the Edit button displayed upon hovering over the connection.

</SS>

 

  • Revoke and delete connections by using the respective options displayed upon hovering over the connection.

</SS>

 


Technicians can set up, use, edit, and delete connections created by other technicians and view the code snippet as well.
You cannot delete a connection that is being used in a custom function.
When you update the scope for a connection, it will be automatically revoked. You must re-authenticate to use the connection again.

 

Learn more about setting up connections for custom services.

 



 

Connections for Custom Services

To set up connections, register the third party application as a service in AssetExplorer Cloud. Connections are equipped with various modes of authentication - API Key, Basic Authentication, OAuth1, OAuth2, AWS Signature.

 

Set Up Connections 

Go to Admin > Developer Space > Connections.

Step 1: Store the third party application details as a service.

 

  • Click Create Connections. Switch to the Custom Services tab and click Create New Service.

  • Alternatively, go to Custom Services in the Connections pane and click Create Services.

  • Fill out the form using the pointers below.

 

Field Name

Description

Service Name

Provide a display name for the service.

Service Link Name

Provide a unique link name to identify the custom service. The link name must contain only alphanumeric characters in snake_case.

Authentication Type

Choose an authentication type based on the third-party service's API documentation.

API Key

  • Specify the parameter type as query string, form data, or header.

  • Enter the parameter and the display name of the parameter.

  • Click to add multiple parameters. You can delete parameters by clicking .

Basic Authentication

  • The parameter type is auto-populated as Header and is non-editable.

  • The service is authenticated using the username and password details.

OAuth1

 

OAuth2

Specify the identity provider details.

  • The parameter type is selected as Header by default.

  • The grant type is selected as Authorization Code by default.

  • Copy the client ID provided in the resource owner.

  • Copy the client secret mapped to AssetExplorer Cloud from the resource owner.

  • Enter the authorization URL of the login page of the resource, where AssetExplorer Cloud can be authenticated with the resource server.

  • Provide the access token URL from the resource's website.

  • Provide the refresh token URL to allow AssetExplorer Cloud to reauthorize access. You can obtain this URL from the resource's website.

  • Provide the access permissions required by AssetExplorer Cloud as scope and enter a scope display name.

AWS Signature

  • The parameter type is auto-populated as Header and is non-editable.

  • Provide a display name for the service.

AWS Region:

 

 

Dynamic Parameters

It can be used as placeholders in the input URL of Deluge webhook tasks and the connection's authentication URL in the format - {ParamLinkName}.

 

 

Using Connections    

Click a connection on the connection home page to view the code snippet and other details.
Copy the Deluge code snippet to a custom function and proceed as follows:
  1. Replace <url> by the URL to be invoked.

  2. Choose the HTTP method.

  3. Pass parameters, if any.

You can add connections to custom widgets by copying the JSON code snippet to a custom widget package. Note the following pointers for reference:

  • Add line breaks after each property in the JSON object.

  • You can set the "userAccess" as "true" to allow users to authorize connections individually. To restrict authorization to only administrators, set userAcess as "false".

Click here to learn more about adding connections to custom widgets.

 

List View Operations 

On this page, you can set up, revoke, and delete connections.
  1. Click Add Connection to create a new connection with default or custom services.

  2. Click Connect on a connection to set up the connection.

  3. View the code snippet of each connection (both active and revoked) by simply clicking the connection.

  4. Modify the name and scope of a connection by using the Edit button displayed upon hovering over the connection. When you update a connection's scope, the connection will automatically be revoked. You must re-authenticate to use the connection.

    </SS>

  5. Revoke and delete connections by using the respective options displayed upon hovering over the Connection.


Technicians can revoke the connections created by other technicians and view the code snippet.
You cannot delete a connection being used in a custom function.

 

</SS>




    • Related Articles

    • Developer Space

      Developer Space contains various modules that can be customized and used across different features in the product. The modules currently available under Developer Space are: Custom Menu Custom Widgets Custom Functions Connections Global Variables ...
    • Relationship Map

      A relationship map helps visualize the connections between a base CI and related CIs. This allows you to identify dependencies between CIs. Role Required: SDAdmin, SDCMDBAdmin, SDCMDBManager. You can access the relationship map in two ways: From the ...
    • Introduction to CMDB

      Configuration Management Database (CMDB) is a centralized repository that stores information about significant entities within an IT environment. It serves as the backbone of IT Service Management (ITSM). Configuration Items (CIs) are critical ...
    • Custom Widgets

      Custom Widgets bring external services inside AssetExplorer Cloud and extend the capabilities of the application. Widgets are embeddable UI components that you can create on your own by using JS Software Development Kit. Custom widgets allow you to ...
    • CMDB Business Views

      Business views enable you to manage saved relationship maps, providing a summary of relationships between CIs. How is a business view different from a relationship map? A relationship map shows connections at a single level between a base CI and a ...