How can I enable API access for ID Agent?

With the Permit access to web services option, partner administrators can enable access to the Dark Web ID API themselves. Also, this option allows partner administrators to enable API access for other partner administrators and partner agents when creating or editing them.
Note: API access cannot be provided to SMB users. 

The Permit access to web services option has been added to the following pages:

  • My Account > My Settings page
  • Create New User page
  • Edit User page

RN-7.18.24-2.png 

To access the API's services, you are required to enter an IP address in the IP Address whitelist field.
RN-7.18.24-1.png

Important: The services provided by Kaseya products for which you may have integrated Dark Web ID are available globally. Therefore, the IP addresses that allow access to these services should not be added for each user.

When the Permit access to web services option is selected for a user, a link to the API Documentation is made available for the user on the Help menu.
API-Doc1.png

Note: If the Permit access to web services option is selected but an IP address is not entered in the IP Address whitelist field, the user will be able to access the API Documentation only. The user will not be able to access the API's services.

To enable API access for yourself (partner administrator):

  1. Select My Account > My Settings.
    API-Doc2.png
  2. At the bottom of the Edit form, select the Permit access to web services check box.
    API-Doc3.png
  3. In the IP Address whitelist field, enter the IP address(es) from which the API calls will be made.
    API-Doc4.png
  4. Click Save.

To enable API access while creating a new user:

  1. At the bottom of the Create New User form, select the Permit access to web services check box.
    API-Doc7.png
  2. In the IP Address whitelist field, enter the IP address from which the API calls will be made.
    API-Doc8.png
  3. Click Save User.

To enable API access by editing an existing user:

  1. In the Partner Users table, click the More menu for the desired user.
    API-Doc5.png
  2. In the pop-up menu, select Edit.
    API-Doc6.png
  3. At the bottom of the Edit User form, select the Permit access to web services check box.
    API-Doc7.png
  4. In the IP Address whitelist field, enter the IP address(es) from which the API calls will be made.
    API-Doc8.png
  5. Click Save User.

 

 

 

 

Have more questions?

Contact us

Was this article helpful?
0 out of 1 found this helpful

Provide feedback for the Documentation team!

Browse this section