Package org.zaproxy.clientapi.gen

Class ForcedUser

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.ForcedUserDeprecated

org.zaproxy.clientapi.gen.ForcedUser

public class ForcedUser
extends ForcedUserDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
ForcedUser(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	getForcedUser(String contextid)	Gets the user (ID) set as 'forced user' for the given context (ID)
ApiResponse	isForcedUserModeEnabled()	Returns 'true' if 'forced user' mode is enabled, 'false' otherwise
ApiResponse	setForcedUser(String contextid, String userid)	Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)
ApiResponse	setForcedUserModeEnabled(boolean bool)	Sets if 'forced user' mode should be enabled or not

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.ForcedUserDeprecated

setForcedUser, setForcedUserModeEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

ForcedUser

public ForcedUser(ClientApi api)

Method Details

isForcedUserModeEnabled

public ApiResponse isForcedUserModeEnabled()
                                    throws ClientApiException

Returns 'true' if 'forced user' mode is enabled, 'false' otherwise

Throws:

ClientApiException

getForcedUser

public ApiResponse getForcedUser(String contextid)
                          throws ClientApiException

Gets the user (ID) set as 'forced user' for the given context (ID)

Throws:

ClientApiException

setForcedUser

public ApiResponse setForcedUser(String contextid,
 String userid)
                          throws ClientApiException

Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)

Throws:

ClientApiException

setForcedUserModeEnabled

public ApiResponse setForcedUserModeEnabled(boolean bool)
                                     throws ClientApiException

Sets if 'forced user' mode should be enabled or not

Throws:

ClientApiException