Package org.zaproxy.clientapi.gen

Class AccessControl

  • public class AccessControl
extends java.lang.Object
    This file was automatically generated.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiResponse getScanProgress​(java.lang.String contextid)
      Gets the Access Control scan progress (percentage integer) for the given context ID.
      ApiResponse getScanStatus​(java.lang.String contextid)
      Gets the Access Control scan status (description string) for the given context ID.
      ApiResponse scan​(java.lang.String contextid, java.lang.String userid, java.lang.String scanasunauthuser, java.lang.String raisealert, java.lang.String alertrisklevel)
      Starts an Access Control scan with the given context ID and user ID.
      ApiResponse writeHTMLreport​(java.lang.String contextid, java.lang.String filename)
      Generates an Access Control report for the given context ID and saves it based on the provided filename (path).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AccessControl

        public AccessControl​(ClientApi api)

    • Method Detail

      • getScanProgress

        public ApiResponse getScanProgress​(java.lang.String contextid)
                            throws ClientApiException
        Gets the Access Control scan progress (percentage integer) for the given context ID.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • getScanStatus

        public ApiResponse getScanStatus​(java.lang.String contextid)
                          throws ClientApiException
        Gets the Access Control scan status (description string) for the given context ID.

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • scan

        public ApiResponse scan​(java.lang.String contextid,
                        java.lang.String userid,
                        java.lang.String scanasunauthuser,
                        java.lang.String raisealert,
                        java.lang.String alertrisklevel)
                 throws ClientApiException
        Starts an Access Control scan with the given context ID and user ID. (Optional parameters: user ID for Unauthenticated user, boolean identifying whether or not Alerts are raised, and the Risk level for the Alerts.) [This assumes the Access Control rules were previously established via ZAP gui and the necessary Context exported/imported.]

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException

      • writeHTMLreport

        public ApiResponse writeHTMLreport​(java.lang.String contextid,
                                   java.lang.String filename)
                            throws ClientApiException
        Generates an Access Control report for the given context ID and saves it based on the provided filename (path).

        This component is optional and therefore the API will only work if it is installed

        Throws:
        ClientApiException