UNPKG

@itentialopensource/adapter-zscaler

Version:

This adapter integrates with system Zscaler

1,041 lines (1,027 loc) 113 kB
## Using this Adapter The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls. ### Generic Adapter Calls These are adapter methods that Itential Platform or you might use. There are some other methods not shown here that might be used for internal adapter functionality. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">connect()</td> <td style="padding:15px">This call is run when the Adapter is first loaded by the Itential Platform. It validates the properties have been provided correctly.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">healthCheck(callback)</td> <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Zscaler. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">refreshProperties(properties)</td> <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">encryptProperty(property, technique, callback)</td> <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Zscaler.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td> <td style="padding:15px">This call provides the ability to update the adapter configuration from Itential Platform - includes actions, schema, mockdata and other configurations.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapSuspendAdapter(mode, callback)</td> <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapUnsuspendAdapter(callback)</td> <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapGetAdapterQueue(callback)</td> <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td> <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapTroubleshootAdapter(props, adapter, callback)</td> <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td> <td style="padding:15px">This call will return the results of a healthcheck.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterConnectivity(callback)</td> <td style="padding:15px">This call will return the results of a connectivity check.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterBasicGet(maxCalls, callback)</td> <td style="padding:15px">This call will return the results of running basic get API calls. By default 5 get calls without parameters will be run. You can ask for more or less by setting maxCalls.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td> <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or Itential Platform Database.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td> <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapActivateTasks(tasks, callback)</td> <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td> <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td> <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td> <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterLint(callback)</td> <td style="padding:15px">Runs lint on the addapter and provides the information back.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRunAdapterTests(callback)</td> <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapGetAdapterInventory(callback)</td> <td style="padding:15px">This call provides some inventory related information about the adapter.</td> <td style="padding:15px">Yes</td> </tr> </table> <br> ### Adapter Cache Calls These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td> <td style="padding:15px">This call populates the adapter cache.</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td> <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td> <td style="padding:15px">Yes</td> </tr> </table> <br> ### Adapter Broker Calls These are adapter methods that are used to integrate to Itential Platform Brokers. This adapter currently supports the following broker calls. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">hasEntities(entityType, entityList, callback)</td> <td style="padding:15px">This call is utilized by the Itential Platform Device Broker to determine if the adapter has a specific entity and item of the entity.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">getDevice(deviceName, callback)</td> <td style="padding:15px">This call returns the details of the requested device.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">getDevicesFiltered(options, callback)</td> <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">isAlive(deviceName, callback)</td> <td style="padding:15px">This call returns whether the device status is active</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">getConfig(deviceName, format, callback)</td> <td style="padding:15px">This call returns the configuration for the selected device.</td> <td style="padding:15px">No</td> </tr> <tr> <td style="padding:15px">iapGetDeviceCount(callback)</td> <td style="padding:15px">This call returns the count of devices.</td> <td style="padding:15px">No</td> </tr> </table> <br> ### Specific Adapter Calls Specific adapter calls are built based on the API of the Adapter for Zscaler. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls. <table border="1" class="bordered-table"> <tr> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th> <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th> </tr> <tr> <td style="padding:15px">getAuthenticatedSession(callback)</td> <td style="padding:15px">Checks if there is an authenticated session</td> <td style="padding:15px">{base_path}/{version}/authenticatedSession?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAuthenticatedSession(credentials, callback)</td> <td style="padding:15px">Creates an authenticated session</td> <td style="padding:15px">{base_path}/{version}/authenticatedSession?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteAuthenticatedSession(callback)</td> <td style="padding:15px">Ends an authenticated session</td> <td style="padding:15px">{base_path}/{version}/authenticatedSession?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditReport(callback)</td> <td style="padding:15px">This endpoint is deprecated, use GET /auditlogEntryReport</td> <td style="padding:15px">{base_path}/{version}/auditReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAuditReport(callback)</td> <td style="padding:15px">This endpoint is deprecated, use POST /auditlogEntryReport</td> <td style="padding:15px">{base_path}/{version}/auditReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteAuditReport(callback)</td> <td style="padding:15px">This endpoint is deprecated, use DELETE /auditlogEntryReport</td> <td style="padding:15px">{base_path}/{version}/auditReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditReportdownload(callback)</td> <td style="padding:15px">This endpoint is deprecated, use GET /auditlogEntryReport/download</td> <td style="padding:15px">{base_path}/{version}/auditReport/download?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditlogEntryReport(callback)</td> <td style="padding:15px">Gets the status of a request for an audit log report</td> <td style="padding:15px">{base_path}/{version}/auditlogEntryReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postAuditlogEntryReport(request, callback)</td> <td style="padding:15px">Creates an audit log report for the specified time period and saves it as a CSV file</td> <td style="padding:15px">{base_path}/{version}/auditlogEntryReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteAuditlogEntryReport(callback)</td> <td style="padding:15px">Cancels the request to create an audit log report</td> <td style="padding:15px">{base_path}/{version}/auditlogEntryReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAuditlogEntryReportdownload(callback)</td> <td style="padding:15px">Downloads the most recently created audit log report</td> <td style="padding:15px">{base_path}/{version}/auditlogEntryReport/download?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDepartments(callback)</td> <td style="padding:15px">Gets a list of departments</td> <td style="padding:15px">{base_path}/{version}/departments?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDepartmentsid(id, callback)</td> <td style="padding:15px">Gets the department for the specified ID</td> <td style="padding:15px">{base_path}/{version}/departments/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getGroups(search, page, pageSize, callback)</td> <td style="padding:15px">Gets a list of groups</td> <td style="padding:15px">{base_path}/{version}/groups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getGroupsgroupId(groupId, callback)</td> <td style="padding:15px">Gets the group for the specified ID</td> <td style="padding:15px">{base_path}/{version}/groups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getUsers(name, dept, group, page, pageSize, callback)</td> <td style="padding:15px">Gets a list of all users and allows user filtering by name, department, or group</td> <td style="padding:15px">{base_path}/{version}/users?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postUsers(user, callback)</td> <td style="padding:15px">Adds a new user</td> <td style="padding:15px">{base_path}/{version}/users?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postUsersbulkDelete(userIds, callback)</td> <td style="padding:15px">Bulk delete users up to a maximum of 500 users per request</td> <td style="padding:15px">{base_path}/{version}/users/bulkDelete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getUsersuserId(userId, callback)</td> <td style="padding:15px">Gets the user information for the specified ID</td> <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">putUsersuserId(userId, user, callback)</td> <td style="padding:15px">Updates the user information for the specified ID</td> <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteUsersuserId(userId, callback)</td> <td style="padding:15px">Deletes the user for the specified ID</td> <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSecurity(callback)</td> <td style="padding:15px">Gets a list of white-listed URLs</td> <td style="padding:15px">{base_path}/{version}/security?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">putSecurity(policy, callback)</td> <td style="padding:15px">Updates the list of white-listed URLs</td> <td style="padding:15px">{base_path}/{version}/security?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSecurityadvanced(callback)</td> <td style="padding:15px">Gets a list of black-listed URLs</td> <td style="padding:15px">{base_path}/{version}/security/advanced?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">putSecurityadvanced(advSettings, callback)</td> <td style="padding:15px">Updates the list of black-listed URLs</td> <td style="padding:15px">{base_path}/{version}/security/advanced?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postSecurityadvancedblacklistUrls(action, callback)</td> <td style="padding:15px">Adds a URL to or removes a URL from the black list</td> <td style="padding:15px">{base_path}/{version}/security/advanced/blacklistUrls?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteSslSettingscertchain(callback)</td> <td style="padding:15px">Deletes the intermediate certificate chain</td> <td style="padding:15px">{base_path}/{version}/sslSettings/certchain?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSslSettingsdownloadcsr(callback)</td> <td style="padding:15px">Downloads a Certificate Signing Request (CSR)</td> <td style="padding:15px">{base_path}/{version}/sslSettings/downloadcsr?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postSslSettingsgeneratecsr(cert, callback)</td> <td style="padding:15px">Generates a Certificate Signing Request (CSR)</td> <td style="padding:15px">{base_path}/{version}/sslSettings/generatecsr?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSslSettingsshowcert(callback)</td> <td style="padding:15px">Shows information about the signed intermediate root certificate</td> <td style="padding:15px">{base_path}/{version}/sslSettings/showcert?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postSslSettingsuploadcerttext(fileInputStream, callback)</td> <td style="padding:15px">Uploads a signed intermediate root certificate for clients that use iframe-based uploads whose content type is text/plain</td> <td style="padding:15px">{base_path}/{version}/sslSettings/uploadcert/text?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postSslSettingsuploadcertchaintext(fileInputStream, callback)</td> <td style="padding:15px">Uploads the Intermediate Certificate Chain (PEM) for clients that use iframe-based uploads whose content type is text/plain</td> <td style="padding:15px">{base_path}/{version}/sslSettings/uploadcertchain/text?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getUrlCategoriesWithOptions(queryData, callback)</td> <td style="padding:15px">Gets information about all or custom URL categories with query data</td> <td style="padding:15px">{base_path}/{version}/urlCategories?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postUrlCategories(customCategory, callback)</td> <td style="padding:15px">Adds a new custom URL category</td> <td style="padding:15px">{base_path}/{version}/urlCategories?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getUrlCategorieslite(callback)</td> <td style="padding:15px">Gets a lightweight key-value list of all or custom URL categories</td> <td style="padding:15px">{base_path}/{version}/urlCategories/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getUrlCategoriesurlQuota(callback)</td> <td style="padding:15px">Gets the URL quota information for your organization</td> <td style="padding:15px">{base_path}/{version}/urlCategories/urlQuota?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getUrlCategoriescategoryId(categoryId, callback)</td> <td style="padding:15px">Gets the URL category information for the specified ID</td> <td style="padding:15px">{base_path}/{version}/urlCategories/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">putUrlCategoriescategoryId(categoryId, action, customCategory, callback)</td> <td style="padding:15px">Updates the URL category for the specified ID</td> <td style="padding:15px">{base_path}/{version}/urlCategories/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteUrlCategoriescategoryId(categoryId, callback)</td> <td style="padding:15px">Deletes the custom URL category for the specified ID</td> <td style="padding:15px">{base_path}/{version}/urlCategories/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postUrlLookup(urls, callback)</td> <td style="padding:15px">Look up the categorization of the given set of URLs, e.g., ['abc.com', 'xyz.com']</td> <td style="padding:15px">{base_path}/{version}/urlLookup?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getVpnCredentials(search, type, includeOnlyWithoutLocation, locationId, managedBy, page, pageSize, callback)</td> <td style="padding:15px">Gets VPN credentials that can be associated to locations</td> <td style="padding:15px">{base_path}/{version}/vpnCredentials?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postVpnCredentials(vpnCred, callback)</td> <td style="padding:15px">Adds VPN credentials that can be associated to locations</td> <td style="padding:15px">{base_path}/{version}/vpnCredentials?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postVpnCredentialsbulkDelete(ids, callback)</td> <td style="padding:15px">Bulk delete VPN credentials up to a maximum of 100 credentials per request</td> <td style="padding:15px">{base_path}/{version}/vpnCredentials/bulkDelete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getVpnCredentialsvpnId(vpnId, callback)</td> <td style="padding:15px">Gets the VPN credentials for the specified ID</td> <td style="padding:15px">{base_path}/{version}/vpnCredentials/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">putVpnCredentialsvpnId(vpnId, vpnCred, callback)</td> <td style="padding:15px">Updates the VPN credentials for the specified ID</td> <td style="padding:15px">{base_path}/{version}/vpnCredentials/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteVpnCredentialsvpnId(vpnId, callback)</td> <td style="padding:15px">Deletes the VPN credentials for the specified ID</td> <td style="padding:15px">{base_path}/{version}/vpnCredentials/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getLocations(search, sslScanEnabled, xffEnabled, authRequired, bwEnforced, page, pageSize, callback)</td> <td style="padding:15px">Gets information on locations</td> <td style="padding:15px">{base_path}/{version}/locations?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postLocations(location, callback)</td> <td style="padding:15px">Adds a new location</td> <td style="padding:15px">{base_path}/{version}/locations?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postLocationsbulkDelete(LocationIds, callback)</td> <td style="padding:15px">Bulk delete locations up to a maximum of 100 locations per request</td> <td style="padding:15px">{base_path}/{version}/locations/bulkDelete?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getLocationslite(sslScanEnabled, search, page, pageSize, callback)</td> <td style="padding:15px">Gets a lightweight list of locations</td> <td style="padding:15px">{base_path}/{version}/locations/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getLocationslocationId(locationId, callback)</td> <td style="padding:15px">Gets the location information for the specified ID</td> <td style="padding:15px">{base_path}/{version}/locations/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">putLocationslocationId(locationId, location, callback)</td> <td style="padding:15px">Updates the location information for the specified ID</td> <td style="padding:15px">{base_path}/{version}/locations/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteLocationslocationId(locationId, callback)</td> <td style="padding:15px">Deletes the location for the specified ID</td> <td style="padding:15px">{base_path}/{version}/locations/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSandboxreportquota(callback)</td> <td style="padding:15px">Gets the Sandbox Report API quota information for your organization</td> <td style="padding:15px">{base_path}/{version}/sandbox/report/quota?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSandboxreportmd5Hash(md5Hash, details, callback)</td> <td style="padding:15px">Gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox</td> <td style="padding:15px">{base_path}/{version}/sandbox/report/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getStatus(callback)</td> <td style="padding:15px">Gets the activation status for a configuration change</td> <td style="padding:15px">{base_path}/{version}/status?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postStatusactivate(callback)</td> <td style="padding:15px">Activates configuration changes</td> <td style="padding:15px">{base_path}/{version}/status/activate?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">submitFile(apiToken, force, callback)</td> <td style="padding:15px">submitFile</td> <td style="padding:15px">{base_path}/{version}/zscsb/submit?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">submitFileForScan(apiToken, callback)</td> <td style="padding:15px">submitFileForScan</td> <td style="padding:15px">{base_path}/{version}/zscsb/discan?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getApp(appId, url, verbose, callback)</td> <td style="padding:15px">getApp</td> <td style="padding:15px">{base_path}/{version}/apps/app?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postApp(body, callback)</td> <td style="padding:15px">postApp</td> <td style="padding:15px">{base_path}/{version}/apps/app?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">appsSearchGET(appName, limit, page, callback)</td> <td style="padding:15px">AppsSearch_GET</td> <td style="padding:15px">{base_path}/{version}/apps/search?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getViews(callback)</td> <td style="padding:15px">getViews</td> <td style="padding:15px">{base_path}/{version}/app_views/list?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getViewApps(appViewId, callback)</td> <td style="padding:15px">getViewApps</td> <td style="padding:15px">{base_path}/{version}/app_views/{pathv1}/apps?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getRoleSummary(includeAuditorRole, includePartnerRole, includeApiRole, callback)</td> <td style="padding:15px">getRoleSummary</td> <td style="padding:15px">{base_path}/{version}/adminRoles/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getAdminUsers(includeAuditorUsers, includeAdminUsers, search, page, pageSize, callback)</td> <td style="padding:15px">getAdminUsers</td> <td style="padding:15px">{base_path}/{version}/adminUsers?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addAdminUser(associateWithExistingAdmin, body, callback)</td> <td style="padding:15px">addAdminUser</td> <td style="padding:15px">{base_path}/{version}/adminUsers?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateAdminUser(userId, callback)</td> <td style="padding:15px">updateAdminUser</td> <td style="padding:15px">{base_path}/{version}/adminUsers/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteAdminUser(userId, callback)</td> <td style="padding:15px">deleteAdminUser</td> <td style="padding:15px">{base_path}/{version}/adminUsers/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">convertAdminToEndUser(userId, body, callback)</td> <td style="padding:15px">convertAdminToEndUser</td> <td style="padding:15px">{base_path}/{version}/adminUsers/{pathv1}/convertToUser?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getCloudBrowserIsolationProfiles(callback)</td> <td style="padding:15px">getCloudBrowserIsolationProfiles</td> <td style="padding:15px">{base_path}/{version}/browserIsolation/profiles?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDlpDictionaries(search, callback)</td> <td style="padding:15px">getDlpDictionaries</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addCustomDLPDictionary(body, callback)</td> <td style="padding:15px">addCustomDLPDictionary</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDLPDictionarySummary(callback)</td> <td style="padding:15px">getDLPDictionarySummary</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDlpDictionaryById(dlpDictId, callback)</td> <td style="padding:15px">getDlpDictionaryById</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateDlpDictionary(dlpDictId, body, callback)</td> <td style="padding:15px">updateDlpDictionary</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteCustomDlpDictionary(dlpDictId, callback)</td> <td style="padding:15px">deleteCustomDlpDictionary</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getPredefinedHierarchicalIdentifiersByDictionaryId(dictId, callback)</td> <td style="padding:15px">getPredefinedHierarchicalIdentifiersByDictionaryId</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries/{pathv1}/predefinedIdentifiers?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">validateDlpPattern(callback)</td> <td style="padding:15px">validateDlpPattern</td> <td style="padding:15px">{base_path}/{version}/dlpDictionaries/validateDlpPattern?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDLPEngines(callback)</td> <td style="padding:15px">getDLPEngines</td> <td style="padding:15px">{base_path}/{version}/dlpEngines?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addCustomDLPEngine(body, callback)</td> <td style="padding:15px">addCustomDLPEngine</td> <td style="padding:15px">{base_path}/{version}/dlpEngines?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDLPEnginesSummary(callback)</td> <td style="padding:15px">getDLPEnginesSummary</td> <td style="padding:15px">{base_path}/{version}/dlpEngines/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">postDlpEnginesValidateDlpExpr(body, callback)</td> <td style="padding:15px">validateDlpPattern</td> <td style="padding:15px">{base_path}/{version}/dlpEngines/validateDlpExpr?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDLPEngineById(dlpEngineId, callback)</td> <td style="padding:15px">getDLPEngineById</td> <td style="padding:15px">{base_path}/{version}/dlpEngines/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateDlpEngine(dlpEngineId, body, callback)</td> <td style="padding:15px">updateDlpEngine</td> <td style="padding:15px">{base_path}/{version}/dlpEngines/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteCustomDlpEngine(dlpEngineId, callback)</td> <td style="padding:15px">deleteCustomDlpEngine</td> <td style="padding:15px">{base_path}/{version}/dlpEngines/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSchemas(callback)</td> <td style="padding:15px">getSchemas</td> <td style="padding:15px">{base_path}/{version}/dlpExactDataMatchSchemas?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSchemaLite(schemaName, activeOnly, fetchTokens, callback)</td> <td style="padding:15px">getSchemaLite</td> <td style="padding:15px">{base_path}/{version}/dlpExactDataMatchSchemas/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">gettemplates(callback)</td> <td style="padding:15px">gettemplates</td> <td style="padding:15px">{base_path}/{version}/dlpNotificationTemplates?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addtemplate(callback)</td> <td style="padding:15px">addtemplate</td> <td style="padding:15px">{base_path}/{version}/dlpNotificationTemplates?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getTemplateById(templateId, callback)</td> <td style="padding:15px">getTemplateById</td> <td style="padding:15px">{base_path}/{version}/dlpNotificationTemplates/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updatetemplate(templateId, callback)</td> <td style="padding:15px">updatetemplate</td> <td style="padding:15px">{base_path}/{version}/dlpNotificationTemplates/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deletetemplate(templateId, callback)</td> <td style="padding:15px">deletetemplate</td> <td style="padding:15px">{base_path}/{version}/dlpNotificationTemplates/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getICAPServers(callback)</td> <td style="padding:15px">getICAPServers</td> <td style="padding:15px">{base_path}/{version}/icapServers?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getICAPServerSummary(callback)</td> <td style="padding:15px">getICAPServerSummary</td> <td style="padding:15px">{base_path}/{version}/icapServers/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getICAPServer(icapServerId, callback)</td> <td style="padding:15px">getICAPServer</td> <td style="padding:15px">{base_path}/{version}/icapServers/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getProfiles(callback)</td> <td style="padding:15px">getProfiles</td> <td style="padding:15px">{base_path}/{version}/idmprofile?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSummary(activeOnly, callback)</td> <td style="padding:15px">getSummary</td> <td style="padding:15px">{base_path}/{version}/idmprofile/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getProfileById(profileId, callback)</td> <td style="padding:15px">getProfileById</td> <td style="padding:15px">{base_path}/{version}/idmprofile/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIncidentReceiverServers(callback)</td> <td style="padding:15px">getIncidentReceiverServers</td> <td style="padding:15px">{base_path}/{version}/incidentReceiverServers?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIncidentReceiverServerSummary(callback)</td> <td style="padding:15px">getIncidentReceiverServerSummary</td> <td style="padding:15px">{base_path}/{version}/incidentReceiverServers/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getIncidentReceiverServer(incidentReceiverServerId, callback)</td> <td style="padding:15px">getIncidentReceiverServer</td> <td style="padding:15px">{base_path}/{version}/incidentReceiverServers/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getRules(callback)</td> <td style="padding:15px">getRules</td> <td style="padding:15px">{base_path}/{version}/webDlpRules?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addRule(body, callback)</td> <td style="padding:15px">addRule</td> <td style="padding:15px">{base_path}/{version}/webDlpRules?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getWebDlpRulesLite(callback)</td> <td style="padding:15px">getSummary</td> <td style="padding:15px">{base_path}/{version}/webDlpRules/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getRuleById(ruleId, callback)</td> <td style="padding:15px">getRuleById</td> <td style="padding:15px">{base_path}/{version}/webDlpRules/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateRule(ruleId, body, callback)</td> <td style="padding:15px">updateRule</td> <td style="padding:15px">{base_path}/{version}/webDlpRules/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteRule(ruleId, callback)</td> <td style="padding:15px">deleteRule</td> <td style="padding:15px">{base_path}/{version}/webDlpRules/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDeviceGroups(includeDeviceInfo, includePseudoGroups, callback)</td> <td style="padding:15px">getDeviceGroups</td> <td style="padding:15px">{base_path}/{version}/deviceGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDevices(name, model, owner, osType, osVersion, deviceGroupId, userIds, searchAll, includeAll, page, pageSize, callback)</td> <td style="padding:15px">getDevices</td> <td style="padding:15px">{base_path}/{version}/deviceGroups/devices?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDevicesLite(name, userIds, includeAll, page, pageSize, callback)</td> <td style="padding:15px">getDevicesLite</td> <td style="padding:15px">{base_path}/{version}/deviceGroups/devices/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getEventReportEntryCsvExportStatus(callback)</td> <td style="padding:15px">getEventReportEntryCsvExportStatus</td> <td style="padding:15px">{base_path}/{version}/eventlogEntryReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">startEventReportEntryCsvExport(body, callback)</td> <td style="padding:15px">startEventReportEntryCsvExport</td> <td style="padding:15px">{base_path}/{version}/eventlogEntryReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">cancelEventReportEntryCsvExport(callback)</td> <td style="padding:15px">cancelEventReportEntryCsvExport</td> <td style="padding:15px">{base_path}/{version}/eventlogEntryReport?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getEventReportEntryCsvData(callback)</td> <td style="padding:15px">getEventReportEntryCsvData</td> <td style="padding:15px">{base_path}/{version}/eventlogEntryReport/download?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getFirewallFilteringRules(callback)</td> <td style="padding:15px">getFirewallFilteringRules</td> <td style="padding:15px">{base_path}/{version}/firewallFilteringRules?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">createFirewallFilteringRule(body, callback)</td> <td style="padding:15px">createFirewallFilteringRule</td> <td style="padding:15px">{base_path}/{version}/firewallFilteringRules?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getFirewallFilteringRule(ruleId, callback)</td> <td style="padding:15px">getFirewallFilteringRule</td> <td style="padding:15px">{base_path}/{version}/firewallFilteringRules/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">updateFirewallFilteringRule(ruleId, body, callback)</td> <td style="padding:15px">updateFirewallFilteringRule</td> <td style="padding:15px">{base_path}/{version}/firewallFilteringRules/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteFirewallFilteringRule(ruleId, callback)</td> <td style="padding:15px">deleteFirewallFilteringRule</td> <td style="padding:15px">{base_path}/{version}/firewallFilteringRules/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDestinationIpGroups(excludeType, callback)</td> <td style="padding:15px">getDestinationIpGroups</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addDestinationIpGroup(callback)</td> <td style="padding:15px">addDestinationIpGroup</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDestinationIpv6Groups(excludeType, callback)</td> <td style="padding:15px">getDestinationIpv6Groups</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups/ipv6DestinationGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDestinationIpv6GroupsLite(type, excludeType, callback)</td> <td style="padding:15px">getDestinationIpv6GroupsLite</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups/ipv6DestinationGroups/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDestinationIpGroupsLite(type, excludeType, callback)</td> <td style="padding:15px">getDestinationIpGroupsLite</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getDestinationIpGroupById(ipGroupId, callback)</td> <td style="padding:15px">getDestinationIpGroupById</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">editDestinationIpGroup(ipGroupId, callback)</td> <td style="padding:15px">editDestinationIpGroup</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteDestinationIpGroup(ipGroupId, callback)</td> <td style="padding:15px">deleteDestinationIpGroup</td> <td style="padding:15px">{base_path}/{version}/ipDestinationGroups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSourceIpGroups(search, callback)</td> <td style="padding:15px">getSourceIpGroups</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">addSourceIpGroup(callback)</td> <td style="padding:15px">addSourceIpGroup</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSourceIpv6Groups(callback)</td> <td style="padding:15px">getSourceIpv6Groups</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups/ipv6SourceGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSourceIpv6GroupsLite(callback)</td> <td style="padding:15px">getSourceIpv6GroupsLite</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups/ipv6SourceGroups/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSourceIpGroupsLite(callback)</td> <td style="padding:15px">getSourceIpGroupsLite</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getSourceIpGroupById(ipGroupId, callback)</td> <td style="padding:15px">getSourceIpGroupById</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">editSourceIpGroup(ipGroupId, callback)</td> <td style="padding:15px">editSourceIpGroup</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">deleteSourceIpGroup(ipGroupId, callback)</td> <td style="padding:15px">deleteSourceIpGroup</td> <td style="padding:15px">{base_path}/{version}/ipSourceGroups/{pathv1}?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNetowrkApplicationGroups(search, callback)</td> <td style="padding:15px">getNetowrkApplicationGroups</td> <td style="padding:15px">{base_path}/{version}/networkApplicationGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">createNetworkApplicationGroup(callback)</td> <td style="padding:15px">createNetworkApplicationGroup</td> <td style="padding:15px">{base_path}/{version}/networkApplicationGroups?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNetowrkApplicationGroupsLite(callback)</td> <td style="padding:15px">getNetowrkApplicationGroupsLite</td> <td style="padding:15px">{base_path}/{version}/networkApplicationGroups/lite?{query}</td> <td style="padding:15px">Yes</td> </tr> <tr> <td style="padding:15px">getNetworkApplicationGroupById(groupId, callback)</td>