netsparker-cloud/src/model/formAuthenticationSettingApiModel.ts

JavaScript client for consuming the Netsparker Cloud API.

/**
 * Invicti Enterprise API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v1
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { RequestFile } from './models';
import { FormAuthenticationCustomScript } from './formAuthenticationCustomScript';
import { FormAuthenticationCyberArkVaultSetting } from './formAuthenticationCyberArkVaultSetting';
import { FormAuthenticationHashicorpVaultSetting } from './formAuthenticationHashicorpVaultSetting';
import { OtpSettings } from './otpSettings';

/**
* Provides credentials for form authentication.
*/
export class FormAuthenticationSettingApiModel {
    /**
    * Gets or sets the custom scripts.
    */
    'customScripts'?: Array<FormAuthenticationCustomScript>;
    /**
    * Gets or sets a value indicating whether to detect Bearer token authorization.
    */
    'detectBearerToken'?: boolean;
    /**
    * Gets or sets a value indicating whether to detect authorization tokens.
    */
    'detectAuthorizationTokens'?: boolean;
    /**
    * Gets or sets whether logout detection is disabled.
    */
    'disableLogoutDetection'?: boolean;
    /**
    * Gets or sets the login form URL.
    */
    'loginFormUrl'?: string;
    /**
    * Gets or sets the login required URL.
    */
    'loginRequiredUrl'?: string;
    /**
    * Gets or sets the logout keyword patterns.
    */
    'logoutKeywordPatterns'?: string;
    /**
    * Gets or sets the logout redirect pattern.
    */
    'logoutRedirectPattern'?: string;
    /**
    * Gets or sets a value indicating whether target URL should be overrided with authenticated page.
    */
    'overrideTargetUrlWithAuthenticatedPage'?: boolean;
    /**
    * Gets or sets the password.
    */
    'password'?: string;
    /**
    * Gets or sets the name of the user.
    */
    'userName'?: string;
    /**
    * Gets or sets the type of form authentication.
    */
    'formAuthType'?: FormAuthenticationSettingApiModel.FormAuthTypeEnum;
    'formAuthIntegrationType'?: FormAuthenticationSettingApiModel.FormAuthIntegrationTypeEnum;
    'otpSettings'?: OtpSettings;
    'hashicorpVaultSetting'?: FormAuthenticationHashicorpVaultSetting;
    'cyberArkVaultSetting'?: FormAuthenticationCyberArkVaultSetting;

    static discriminator: string | undefined = undefined;

    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
        {
            "name": "customScripts",
            "baseName": "CustomScripts",
            "type": "Array<FormAuthenticationCustomScript>"
        },
        {
            "name": "detectBearerToken",
            "baseName": "DetectBearerToken",
            "type": "boolean"
        },
        {
            "name": "detectAuthorizationTokens",
            "baseName": "DetectAuthorizationTokens",
            "type": "boolean"
        },
        {
            "name": "disableLogoutDetection",
            "baseName": "DisableLogoutDetection",
            "type": "boolean"
        },
        {
            "name": "loginFormUrl",
            "baseName": "LoginFormUrl",
            "type": "string"
        },
        {
            "name": "loginRequiredUrl",
            "baseName": "LoginRequiredUrl",
            "type": "string"
        },
        {
            "name": "logoutKeywordPatterns",
            "baseName": "LogoutKeywordPatterns",
            "type": "string"
        },
        {
            "name": "logoutRedirectPattern",
            "baseName": "LogoutRedirectPattern",
            "type": "string"
        },
        {
            "name": "overrideTargetUrlWithAuthenticatedPage",
            "baseName": "OverrideTargetUrlWithAuthenticatedPage",
            "type": "boolean"
        },
        {
            "name": "password",
            "baseName": "Password",
            "type": "string"
        },
        {
            "name": "userName",
            "baseName": "UserName",
            "type": "string"
        },
        {
            "name": "formAuthType",
            "baseName": "FormAuthType",
            "type": "FormAuthenticationSettingApiModel.FormAuthTypeEnum"
        },
        {
            "name": "formAuthIntegrationType",
            "baseName": "FormAuthIntegrationType",
            "type": "FormAuthenticationSettingApiModel.FormAuthIntegrationTypeEnum"
        },
        {
            "name": "otpSettings",
            "baseName": "OtpSettings",
            "type": "OtpSettings"
        },
        {
            "name": "hashicorpVaultSetting",
            "baseName": "HashicorpVaultSetting",
            "type": "FormAuthenticationHashicorpVaultSetting"
        },
        {
            "name": "cyberArkVaultSetting",
            "baseName": "CyberArkVaultSetting",
            "type": "FormAuthenticationCyberArkVaultSetting"
        }    ];

    static getAttributeTypeMap() {
        return FormAuthenticationSettingApiModel.attributeTypeMap;
    }
}

export namespace FormAuthenticationSettingApiModel {
    export enum FormAuthTypeEnum {
        Manual = <any> 'Manual',
        Integration = <any> 'Integration'
    }
    export enum FormAuthIntegrationTypeEnum {
        HashiCorp = <any> 'HashiCorp',
        CyberArk = <any> 'CyberArk'
    }
}