ManageEngine ServiceDesk Plus
  • 19 Feb 2024
  • 4 Minutes to read
  • Dark
    Light
  • PDF

ManageEngine ServiceDesk Plus

  • Dark
    Light
  • PDF

Article Summary

ManageEngine ServiceDesk Plus is an IT help desk and customer support system.

Related Enforcement Action:
ManageEngine ServiceDesk Plus - Create Request
ManageEngine ServiceDesk Plus - Create Request per Asset


Types of Assets Fetched

This adapter fetches the following types of assets:

  • Devices

Parameters

  1. Host Name or IP Address (required) - The hostname or IP address of the ManageEngine ServiceDesk Plus server that Axonius can communicate with.

  2. Select Authentication method either oAuth 2.0 or Basic Authentication.
    Basic Authentication:

    1. Technician key token (required) - Use for on-prem deployment of ManageEngine ServiceDesk Plus. An API Key associated with a user account that has the Required Permissions to fetch assets.
      To obtain a technician key token, see Generate a Technician Key Token.

oAuth 2.0

  • Use for cloud deployment of ManageEngine ServiceDesk Plus (SDP).
    a. OAuth Client ID, OAuth Client Secret and OAuth Refresh Token - parameters for OAuth authentication, used in the cloud version of ManageEngine ServiceDesk Plus. Refer to Configuring OAuth Authentication for information on how to generate them.
    b. OAuth Zoho Accounts URL - Select the account URL, or add your own. Refer to Refresh Access Tokens for information on how to obtain the account URL.
  1. Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

  2. HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

  3. HTTPS Proxy User Name (optional) - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.

  4. HTTPS Proxy Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

ManageEngineSDPNEW


Advanced Settings

Note:

Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to ​Advanced Configuration for Adapters.

  1. Enrich device with installed software data - Select this option to enrich devices with data about installed software.
  2. Exclude devices with the Product Type (optional) - Enter device product type values to exclude.
  3. Include Only Devices with Last Seen value - Select this option to include devices in which Last Seen information is available.
  4. Exclude devices with the Product Type - Enter specific device product type values to exclude.

Showing Advanced Fields in Basic View

You can configure fields that generally appear in 'Advanced' to appear in 'Basic' view.
Use the plus sign to add an entry to each field.

ManageEngineAdditionalFields

Enter fields in the following JSON format:

[
{
    "label":"My First Field", 
    "raw_field": "field_a",
    "field_type": "str"
},
{
    "label":"My Second Field",
    "raw_field": "field_b",
    "field_type": "int"
}
]
  • label - the name for the field you want to appear in the basic view

  • raw_field - the name of the field as it appears in JSON format on the Adapter Connections page of the Asset Profile (or Advanced view table)

  • field_type -the field type as it appears in JSON format. The following field types are supported. int, string, datetime, float, bool. You can write them in the following ways:

    'int', 'string', 'str', 'date', 'datetime', 'float', 'bool', 'boolean'.

Note:

To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.

APIs

Axonius uses the following APIs:

  • api/v3/assets
  • api/v3/workstations


Generate a Technician Key Token

Note:
  • Only an administrator can generate the authentication key for technicians with login permission.
  • If a login for the technician is disabled, then the API key is deleted.



To generate an API Key for Technician Key Token

  1. From the User section, click Admin > Technicians icon.

  2. If you want to generate the API key for an existing technician, click Edit_icon.png
    (Edit) on the same row as the desired technician. If you want to generate the API key for a new technician, click Add New Technician, enter the technician details and provide the login permission. The Generate API Key window appears.
    Generate API Key.png

  3. In Key expires on, click the Never expires option to generate a permanent API Key.

  4. Click Generate. If a key is already generated for the technician, click Regenerate.

  5. Copy the API Key and paste it into the Axonius API Key parameter.


Configuring OAuth Authentication

This adapter supports OAuth Authentication

Generating the OAuth Client ID, OAuth Client Secret and OAuth Refresh Token

To use OAuth Authentication you need to generate the OAuth Client ID, OAuth Client Secret and OAuth Refresh Token. To generate them:

  1. Go to the Zoho API Console: https://api-console.zoho.com/

  2. Click 'Add client', choose 'Self Client' and click 'Create' (if a popup asks you to confirm, click “OK“).

  3. On the API Console main page, click on the 'Self Client' application

  4. In the tab 'Generate Code', enter the following details, and click 'Create':

    • Scope:
      • "SDPOnDemand.assets.READ"
      • Time Duration: “10 minutes”
      • Scope Description: free text (could be anything)
  5. A popup “Generated Code“ opens, click copy, and paste the code in a temporary file.

  6. In the tab “Client Secret“, copy “Client ID“ and “Client Secret“ to a temporary file

  7. Enter the values you’ve copied to the following command on a linux machine (or Windows with curl):

curl -X POST "https://accounts.zoho.com/oauth/v2/token?grant_type=authorization_code&code=<code>&client_id=<client_id>&client_secret=<client_secret>"
  1. From the response of the command, copy the value of “refresh_token“, and save it to a temporary file.
  2. Copy the OAuth Client ID, OAuth Client Secret, OAuth Refresh Token to the appropriate places in the Configuration dialog.

Required Permissions

The value supplied in Technician key token must be associated with credentials that have Read-only permissions in order to fetch assets.


Supported From Version

Supported from Axonius version 4.7



Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.