- 19 Feb 2024
- 4 Minutes to read
- Updated on 19 Feb 2024
- 4 Minutes to read
Zendesk is a cloud-based help desk management solution offering customizable tools to build customer service portal, knowledge base, and online communities.
|Cybersecurity Asset Management
|Service Account Required?
|Service Account Permissions
|API Key Required
|Required Adapter Fields
|Sub Domain, Username, API Key/Token
|Sub Domain, Username and Password, API Key/Token, 2FA Secret Key
Types of Assets Fetched
This adapter fetches the following types of assets:
- SaaS data
The parameters that you need to fill out will differ based on the capabilities in your Axonius platform. 'General' pertains to users with Cybersecurity Asset Management and/or SaaS Management capabilities.
Sub Domain (required) - The subdomain used to access Zendesk. For example, Axonius is the subdomain for https://axonius.zendesk.com/.
User Name (required) - The username of an Axonius dedicated user account.
API Key/Token (required) - An API Key/Token associated with a user account that has permissions to fetch assets.
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.
HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.
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.
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.
- Password - The password of the Axonius dedicated user account.
- 2FA Secret Key - The secret generated in Zendesk for setting up two-factor authentication for the Zendesk user created to collect SaaS Management data. See Zendesk documentation for instructions on how to set up two-factor authentication (2FA) and generate the 2FA secret.
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.
- Roles to Fetch - From the dropdown, select the users' roles to fetch.
Fetch EC Action ticket updates - Select this option to configure the adapter to fetch updates on tickets created by Axonius users. The updated ticket information is displayed in the Tickets table showing information on all tickets in the system (Assets> Tickets) or on Tickets of a specific asset (in the Asset Profile of the relevant asset).
Axonius uses the following APIs:
While to access SaaS data you need to grant roles and/or permissions that include write capabilities, the adapter only actually reads data from the application. This applies to both the user account and the credentials associated with the API key.
Adapter Integration Setup
To successfully connect this adapter, you need to create a user account and an API token by completing the following steps:
Create a New User Account
It is recommended for the username and password to be derived from a newly created user account dedicated for the usage of Axonius. Retrieve the username and password from that user account.
When single-sign-on is enabled, it is recommended to derive the Email address and password from a user account maintained by the single-sign-on solution. Please contact Axonius support for assistance.
- Log in as an admin to the Admin Center. In the sidebar, click People in the sidebar, then select Team > Team members.
- At the top of the page, click Add user.
- Enter the user's Name and Email.
- Choose a Staff member for the User type.
- Select the Administrator role.
- Click Add.
Generating a New API Token
API tokens can be used by anyone on the account and aren't associated with specific users. Admins can view, add, delete, and manage API tokens in the Zendesk Admin interface. To generate an API token, you must be an administrator and API token access must be enabled.
API token access is disabled by default. Before you can generate an API token, enable API token access. Once you have enabled API token access, admins can generate an API token.
To enable API token access and to generate an API token:
- Log in as an admin. In the Admin Center, in the sidebar, click Apps and integrations in the sidebar, then select APIs > Zendesk APIs.
- Click the Token Access toggle to enable API token access.
- Click the Settings tab, and then click Add API token to the right of Active API Tokens.
The token is generated and displayed.
- Enter an API token description.
- Copy the generated API token.
- Click Save to return to the API page.
- Back in Axonius, paste the copied token in the API Key/Token field in the ZenDesk adapter connection form.