Package org.zaproxy.clientapi.gen

Class Authentication

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.AuthenticationDeprecated

org.zaproxy.clientapi.gen.Authentication

public class Authentication
extends AuthenticationDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Authentication(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	getAuthenticationMethod(String contextid)	Gets the name of the authentication method for the context with the given ID.
ApiResponse	getAuthenticationMethodConfigParams(String authmethodname)	Gets the configuration parameters for the authentication method with the given name.
ApiResponse	getLoggedInIndicator(String contextid)	Gets the logged in indicator for the context with the given ID.
ApiResponse	getLoggedOutIndicator(String contextid)	Gets the logged out indicator for the context with the given ID.
ApiResponse	getSupportedAuthenticationMethods()	Gets the name of the authentication methods.
ApiResponse	setAuthenticationMethod(String contextid, String authmethodname, String authmethodconfigparams)	Sets the authentication method for the context with the given ID.
ApiResponse	setLoggedInIndicator(String contextid, String loggedinindicatorregex)	Sets the logged in indicator for the context with the given ID.
ApiResponse	setLoggedOutIndicator(String contextid, String loggedoutindicatorregex)	Sets the logged out indicator for the context with the given ID.

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

setAuthenticationMethod, setLoggedInIndicator, setLoggedOutIndicator

Methods inherited from class java.lang.Object

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

Constructor Details

Authentication

public Authentication(ClientApi api)

Method Details

getSupportedAuthenticationMethods

public ApiResponse getSupportedAuthenticationMethods()
                                              throws ClientApiException

Gets the name of the authentication methods.

Throws:

ClientApiException

getAuthenticationMethodConfigParams

public ApiResponse getAuthenticationMethodConfigParams(String authmethodname)
                                                throws ClientApiException

Gets the configuration parameters for the authentication method with the given name.

Throws:

ClientApiException

getAuthenticationMethod

public ApiResponse getAuthenticationMethod(String contextid)
                                    throws ClientApiException

Gets the name of the authentication method for the context with the given ID.

Throws:

ClientApiException

getLoggedInIndicator

public ApiResponse getLoggedInIndicator(String contextid)
                                 throws ClientApiException

Gets the logged in indicator for the context with the given ID.

Throws:

ClientApiException

getLoggedOutIndicator

public ApiResponse getLoggedOutIndicator(String contextid)
                                  throws ClientApiException

Gets the logged out indicator for the context with the given ID.

Throws:

ClientApiException

setAuthenticationMethod

public ApiResponse setAuthenticationMethod(String contextid,
 String authmethodname,
 String authmethodconfigparams)
                                    throws ClientApiException

Sets the authentication method for the context with the given ID.

Throws:

ClientApiException

setLoggedInIndicator

public ApiResponse setLoggedInIndicator(String contextid,
 String loggedinindicatorregex)
                                 throws ClientApiException

Sets the logged in indicator for the context with the given ID.

Throws:

ClientApiException

setLoggedOutIndicator

public ApiResponse setLoggedOutIndicator(String contextid,
 String loggedoutindicatorregex)
                                  throws ClientApiException

Sets the logged out indicator for the context with the given ID.

Throws:

ClientApiException