Package org.zaproxy.clientapi.gen

Class AccessControl

java.lang.Object

org.zaproxy.clientapi.gen.AccessControl

public class AccessControl
extends Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
AccessControl(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	getScanProgress(String contextid)	Gets the Access Control scan progress (percentage integer) for the given context ID.
ApiResponse	getScanStatus(String contextid)	Gets the Access Control scan status (description string) for the given context ID.
ApiResponse	scan(String contextid, String userid, String scanasunauthuser, String raisealert, String alertrisklevel)	Starts an Access Control scan with the given context ID and user ID.
ApiResponse	writeHTMLreport(String contextid, 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 Details

AccessControl

public AccessControl(ClientApi api)

Method Details

getScanProgress

public ApiResponse getScanProgress(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(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(String contextid,
 String userid,
 String scanasunauthuser,
 String raisealert,
 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(String contextid,
 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