org.zaproxy.clientapi.gen.Authentication Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zap-clientapi Show documentation
Java implementation to access OWASP ZAP API.
There is a newer version: 1.14.0
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2017 The ZAP Development Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.zaproxy.clientapi.gen;

import java.util.HashMap;
import java.util.Map;
import org.zaproxy.clientapi.core.ApiResponse;
import org.zaproxy.clientapi.core.ClientApi;
import org.zaproxy.clientapi.core.ClientApiException;

/** This file was automatically generated. */
@SuppressWarnings("javadoc")
public class Authentication extends org.zaproxy.clientapi.gen.deprecated.AuthenticationDeprecated {

    private final ClientApi api;

    public Authentication(ClientApi api) {
        super(api);
        this.api = api;
    }

    /** Gets the name of the authentication methods. */
    public ApiResponse getSupportedAuthenticationMethods() throws ClientApiException {
        return api.callApi("authentication", "view", "getSupportedAuthenticationMethods", null);
    }

    /** Gets the configuration parameters for the authentication method with the given name. */
    public ApiResponse getAuthenticationMethodConfigParams(String authmethodname)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("authMethodName", authmethodname);
        return api.callApi("authentication", "view", "getAuthenticationMethodConfigParams", map);
    }

    /** Gets the name of the authentication method for the context with the given ID. */
    public ApiResponse getAuthenticationMethod(String contextid) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("contextId", contextid);
        return api.callApi("authentication", "view", "getAuthenticationMethod", map);
    }

    /** Gets the logged in indicator for the context with the given ID. */
    public ApiResponse getLoggedInIndicator(String contextid) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("contextId", contextid);
        return api.callApi("authentication", "view", "getLoggedInIndicator", map);
    }

    /** Gets the logged out indicator for the context with the given ID. */
    public ApiResponse getLoggedOutIndicator(String contextid) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("contextId", contextid);
        return api.callApi("authentication", "view", "getLoggedOutIndicator", map);
    }

    /** Sets the authentication method for the context with the given ID. */
    public ApiResponse setAuthenticationMethod(
            String contextid, String authmethodname, String authmethodconfigparams)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("contextId", contextid);
        map.put("authMethodName", authmethodname);
        if (authmethodconfigparams != null) {
            map.put("authMethodConfigParams", authmethodconfigparams);
        }
        return api.callApi("authentication", "action", "setAuthenticationMethod", map);
    }

    /** Sets the logged in indicator for the context with the given ID. */
    public ApiResponse setLoggedInIndicator(String contextid, String loggedinindicatorregex)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("contextId", contextid);
        map.put("loggedInIndicatorRegex", loggedinindicatorregex);
        return api.callApi("authentication", "action", "setLoggedInIndicator", map);
    }

    /** Sets the logged out indicator for the context with the given ID. */
    public ApiResponse setLoggedOutIndicator(String contextid, String loggedoutindicatorregex)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("contextId", contextid);
        map.put("loggedOutIndicatorRegex", loggedoutindicatorregex);
        return api.callApi("authentication", "action", "setLoggedOutIndicator", map);
    }
}