model_mfa_provider.go

/*
Appgate SDP Controller REST API

# About   This specification documents the REST API calls for the Appgate SDP Controller.    Please refer to the REST API chapter in the manual or contact Appgate support with any questions about   this functionality. # Getting Started   Requirements for API scripting:   - Access to the Admin/API TLS Connection (default port 8443) of a Controller appliance.     (https://sdphelp.appgate.com/adminguide/appliance-function-configure.html?anchor=admin-api)   - An API user with relevant permissions.     (https://sdphelp.appgate.com/adminguide/administrative-roles-configure.html)   - In order to use the simple login API, Admin MFA must be disabled or the API user must be excluded.     (https://sdphelp.appgate.com/adminguide/mfa-for-admins.html) # Base path   HTTPS requests must be sent to the Admin Interface hostname and port, with **_/admin** path.    For example: **https://appgate.company.com:8443/admin**    All requests must have the **Accept** header as:    **application/vnd.appgate.peer-v17+json** # API Conventions   API conventions are  important to understand and follow strictly.    - While updating objects (via PUT), entire object must be sent with all fields.     - For example, in order to add a remedy method to the condition below:       ```       {         \"id\": \"12699e27-b584-464a-81ee-5b4784b6d425\",         \"name\": \"Test\",         \"notes\": \"Making a point\",         \"tags\": [\"test\", \"tag\"],         \"expression\": \"return true;\",         \"remedyMethods\": []       }       ```     - send the entire object with updated and non-updated fields:       ```       {         \"id\": \"12699e27-b584-464a-81ee-5b4784b6d425\",         \"name\": \"Test\",         \"notes\": \"Making a point\",         \"tags\": [\"test\", \"tag\"],         \"expression\": \"return true;\",         \"remedyMethods\": [{\"type\": \"DisplayMessage\", \"message\": \"test message\"}]       }       ```    - In case Controller returns an error (non-2xx HTTP status code), response body is JSON.     The \"message\" field contains information about the error.     HTTP 422 \"Unprocessable Entity\" has extra `errors` field to list all the issues with specific fields.    - Empty string (\"\") is considered a different value than \"null\" or field being omitted from JSON.     Omitting the field is recommended if no value is intended.     Empty string (\"\") will be almost always rejected as invalid value.    - There are common pattern between many objects:     - **Configuration Objects**: There are many objects with common fields, namely \"id\", \"name\", \"notes\", \"created\"       and \"updated\". These entities are listed, queried, created, updated and deleted in a similar fashion.     - **Distinguished Name**: Users and Devices are identified with what is called Distinguished Names, as used in        LDAP. The distinguished format that identifies a device and a user combination is        \"CN=\\<Device ID\\>,CN=\\<username\\>,OU=\\<Identity Provider Name\\>\". Some objects have the        \"userDistinguishedName\" field, which does not include the CN for Device ID.        This identifies a user on every device.

API version: API version 17.6
Contact: appgatesdp.support@appgate.com
*/

// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.

package openapi

import (
	"encoding/json"
	"time"
)

// MfaProvider struct for MfaProvider
type MfaProvider struct {
	// ID of the object.
	Id *string `json:"id,omitempty"`
	// Name of the object.
	Name string `json:"name"`
	// Notes for the object. Used for documentation purposes.
	Notes *string `json:"notes,omitempty"`
	// Create date.
	Created *time.Time `json:"created,omitempty"`
	// Last update date.
	Updated *time.Time `json:"updated,omitempty"`
	// Array of tags.
	Tags []string `json:"tags,omitempty"`
	// The type of the MFA Provider. \"DefaultTimeBased\" and \"Fido2\" are built-in, new ones cannot be created.
	Type string `json:"type"`
	// Hostnames/IP addresses to connect.
	Hostnames []string `json:"hostnames,omitempty"`
	// Port to connect.
	Port *float32 `json:"port,omitempty"`
	// The input type used in the client to enter the MFA code.   * \"Masked\" - The input is masked the same way as a password field.  * \"Numeric\" - The input is marked as a numeric input.  * \"Text\" - The input is handled as a regular plain text field.
	InputType *string `json:"inputType,omitempty"`
	// Radius shared secret to authenticate to the server.
	SharedSecret *string `json:"sharedSecret,omitempty"`
	// Radius protocol to use while authenticating users.
	AuthenticationProtocol *string `json:"authenticationProtocol,omitempty"`
	// Timeout in seconds before giving up on response.
	Timeout *float32 `json:"timeout,omitempty"`
	// Defines the multi-factor authentication flow for RADIUS.  * \"OneFactor\" - The input from the user is sent as password and the response is used for result.  * \"Challenge\" - Before prompting the user, Controller sends a challenge request to the RADIUS server  using \"challengeSharedSecret\" or the user password. Data from the response is used with user input to  send the second RADIUS authentication request.  * \"Push\" - \"challengeSharedSecret\" or the user password is sent to RADIUS which triggers an external  authentication flow. When the external authentication flow returns success, the MFA attempt is  authenticated.
	Mode *string `json:"mode,omitempty"`
	// -> If enabled, the Client will send the cached password instead of using challengeSharedSecret\" to initiate the multi-factor authentication.
	UseUserPassword *bool `json:"useUserPassword,omitempty"`
	// -> Password sent to RADIUS to initiate multi-factor authentication. Required if \"useUserPassword\" is not enabled.
	ChallengeSharedSecret *string `json:"challengeSharedSecret,omitempty"`
}

// NewMfaProvider instantiates a new MfaProvider object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewMfaProvider(name string, type_ string) *MfaProvider {
	this := MfaProvider{}
	this.Name = name
	this.Type = type_
	var inputType string = "Masked"
	this.InputType = &inputType
	var authenticationProtocol string = "CHAP"
	this.AuthenticationProtocol = &authenticationProtocol
	var timeout float32 = 6
	this.Timeout = &timeout
	var mode string = "Challenge"
	this.Mode = &mode
	return &this
}

// NewMfaProviderWithDefaults instantiates a new MfaProvider object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewMfaProviderWithDefaults() *MfaProvider {
	this := MfaProvider{}
	var inputType string = "Masked"
	this.InputType = &inputType
	var authenticationProtocol string = "CHAP"
	this.AuthenticationProtocol = &authenticationProtocol
	var timeout float32 = 6
	this.Timeout = &timeout
	var mode string = "Challenge"
	this.Mode = &mode
	return &this
}

// GetId returns the Id field value if set, zero value otherwise.
func (o *MfaProvider) GetId() string {
	if o == nil || o.Id == nil {
		var ret string
		return ret
	}
	return *o.Id
}

// GetIdOk returns a tuple with the Id field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetIdOk() (*string, bool) {
	if o == nil || o.Id == nil {
		return nil, false
	}
	return o.Id, true
}

// HasId returns a boolean if a field has been set.
func (o *MfaProvider) HasId() bool {
	if o != nil && o.Id != nil {
		return true
	}

	return false
}

// SetId gets a reference to the given string and assigns it to the Id field.
func (o *MfaProvider) SetId(v string) {
	o.Id = &v
}

// GetName returns the Name field value
func (o *MfaProvider) GetName() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Name
}

// GetNameOk returns a tuple with the Name field value
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetNameOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Name, true
}

// SetName sets field value
func (o *MfaProvider) SetName(v string) {
	o.Name = v
}

// GetNotes returns the Notes field value if set, zero value otherwise.
func (o *MfaProvider) GetNotes() string {
	if o == nil || o.Notes == nil {
		var ret string
		return ret
	}
	return *o.Notes
}

// GetNotesOk returns a tuple with the Notes field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetNotesOk() (*string, bool) {
	if o == nil || o.Notes == nil {
		return nil, false
	}
	return o.Notes, true
}

// HasNotes returns a boolean if a field has been set.
func (o *MfaProvider) HasNotes() bool {
	if o != nil && o.Notes != nil {
		return true
	}

	return false
}

// SetNotes gets a reference to the given string and assigns it to the Notes field.
func (o *MfaProvider) SetNotes(v string) {
	o.Notes = &v
}

// GetCreated returns the Created field value if set, zero value otherwise.
func (o *MfaProvider) GetCreated() time.Time {
	if o == nil || o.Created == nil {
		var ret time.Time
		return ret
	}
	return *o.Created
}

// GetCreatedOk returns a tuple with the Created field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetCreatedOk() (*time.Time, bool) {
	if o == nil || o.Created == nil {
		return nil, false
	}
	return o.Created, true
}

// HasCreated returns a boolean if a field has been set.
func (o *MfaProvider) HasCreated() bool {
	if o != nil && o.Created != nil {
		return true
	}

	return false
}

// SetCreated gets a reference to the given time.Time and assigns it to the Created field.
func (o *MfaProvider) SetCreated(v time.Time) {
	o.Created = &v
}

// GetUpdated returns the Updated field value if set, zero value otherwise.
func (o *MfaProvider) GetUpdated() time.Time {
	if o == nil || o.Updated == nil {
		var ret time.Time
		return ret
	}
	return *o.Updated
}

// GetUpdatedOk returns a tuple with the Updated field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetUpdatedOk() (*time.Time, bool) {
	if o == nil || o.Updated == nil {
		return nil, false
	}
	return o.Updated, true
}

// HasUpdated returns a boolean if a field has been set.
func (o *MfaProvider) HasUpdated() bool {
	if o != nil && o.Updated != nil {
		return true
	}

	return false
}

// SetUpdated gets a reference to the given time.Time and assigns it to the Updated field.
func (o *MfaProvider) SetUpdated(v time.Time) {
	o.Updated = &v
}

// GetTags returns the Tags field value if set, zero value otherwise.
func (o *MfaProvider) GetTags() []string {
	if o == nil || o.Tags == nil {
		var ret []string
		return ret
	}
	return o.Tags
}

// GetTagsOk returns a tuple with the Tags field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetTagsOk() ([]string, bool) {
	if o == nil || o.Tags == nil {
		return nil, false
	}
	return o.Tags, true
}

// HasTags returns a boolean if a field has been set.
func (o *MfaProvider) HasTags() bool {
	if o != nil && o.Tags != nil {
		return true
	}

	return false
}

// SetTags gets a reference to the given []string and assigns it to the Tags field.
func (o *MfaProvider) SetTags(v []string) {
	o.Tags = v
}

// GetType returns the Type field value
func (o *MfaProvider) GetType() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Type
}

// GetTypeOk returns a tuple with the Type field value
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetTypeOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Type, true
}

// SetType sets field value
func (o *MfaProvider) SetType(v string) {
	o.Type = v
}

// GetHostnames returns the Hostnames field value if set, zero value otherwise.
func (o *MfaProvider) GetHostnames() []string {
	if o == nil || o.Hostnames == nil {
		var ret []string
		return ret
	}
	return o.Hostnames
}

// GetHostnamesOk returns a tuple with the Hostnames field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetHostnamesOk() ([]string, bool) {
	if o == nil || o.Hostnames == nil {
		return nil, false
	}
	return o.Hostnames, true
}

// HasHostnames returns a boolean if a field has been set.
func (o *MfaProvider) HasHostnames() bool {
	if o != nil && o.Hostnames != nil {
		return true
	}

	return false
}

// SetHostnames gets a reference to the given []string and assigns it to the Hostnames field.
func (o *MfaProvider) SetHostnames(v []string) {
	o.Hostnames = v
}

// GetPort returns the Port field value if set, zero value otherwise.
func (o *MfaProvider) GetPort() float32 {
	if o == nil || o.Port == nil {
		var ret float32
		return ret
	}
	return *o.Port
}

// GetPortOk returns a tuple with the Port field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetPortOk() (*float32, bool) {
	if o == nil || o.Port == nil {
		return nil, false
	}
	return o.Port, true
}

// HasPort returns a boolean if a field has been set.
func (o *MfaProvider) HasPort() bool {
	if o != nil && o.Port != nil {
		return true
	}

	return false
}

// SetPort gets a reference to the given float32 and assigns it to the Port field.
func (o *MfaProvider) SetPort(v float32) {
	o.Port = &v
}

// GetInputType returns the InputType field value if set, zero value otherwise.
func (o *MfaProvider) GetInputType() string {
	if o == nil || o.InputType == nil {
		var ret string
		return ret
	}
	return *o.InputType
}

// GetInputTypeOk returns a tuple with the InputType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetInputTypeOk() (*string, bool) {
	if o == nil || o.InputType == nil {
		return nil, false
	}
	return o.InputType, true
}

// HasInputType returns a boolean if a field has been set.
func (o *MfaProvider) HasInputType() bool {
	if o != nil && o.InputType != nil {
		return true
	}

	return false
}

// SetInputType gets a reference to the given string and assigns it to the InputType field.
func (o *MfaProvider) SetInputType(v string) {
	o.InputType = &v
}

// GetSharedSecret returns the SharedSecret field value if set, zero value otherwise.
func (o *MfaProvider) GetSharedSecret() string {
	if o == nil || o.SharedSecret == nil {
		var ret string
		return ret
	}
	return *o.SharedSecret
}

// GetSharedSecretOk returns a tuple with the SharedSecret field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetSharedSecretOk() (*string, bool) {
	if o == nil || o.SharedSecret == nil {
		return nil, false
	}
	return o.SharedSecret, true
}

// HasSharedSecret returns a boolean if a field has been set.
func (o *MfaProvider) HasSharedSecret() bool {
	if o != nil && o.SharedSecret != nil {
		return true
	}

	return false
}

// SetSharedSecret gets a reference to the given string and assigns it to the SharedSecret field.
func (o *MfaProvider) SetSharedSecret(v string) {
	o.SharedSecret = &v
}

// GetAuthenticationProtocol returns the AuthenticationProtocol field value if set, zero value otherwise.
func (o *MfaProvider) GetAuthenticationProtocol() string {
	if o == nil || o.AuthenticationProtocol == nil {
		var ret string
		return ret
	}
	return *o.AuthenticationProtocol
}

// GetAuthenticationProtocolOk returns a tuple with the AuthenticationProtocol field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetAuthenticationProtocolOk() (*string, bool) {
	if o == nil || o.AuthenticationProtocol == nil {
		return nil, false
	}
	return o.AuthenticationProtocol, true
}

// HasAuthenticationProtocol returns a boolean if a field has been set.
func (o *MfaProvider) HasAuthenticationProtocol() bool {
	if o != nil && o.AuthenticationProtocol != nil {
		return true
	}

	return false
}

// SetAuthenticationProtocol gets a reference to the given string and assigns it to the AuthenticationProtocol field.
func (o *MfaProvider) SetAuthenticationProtocol(v string) {
	o.AuthenticationProtocol = &v
}

// GetTimeout returns the Timeout field value if set, zero value otherwise.
func (o *MfaProvider) GetTimeout() float32 {
	if o == nil || o.Timeout == nil {
		var ret float32
		return ret
	}
	return *o.Timeout
}

// GetTimeoutOk returns a tuple with the Timeout field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetTimeoutOk() (*float32, bool) {
	if o == nil || o.Timeout == nil {
		return nil, false
	}
	return o.Timeout, true
}

// HasTimeout returns a boolean if a field has been set.
func (o *MfaProvider) HasTimeout() bool {
	if o != nil && o.Timeout != nil {
		return true
	}

	return false
}

// SetTimeout gets a reference to the given float32 and assigns it to the Timeout field.
func (o *MfaProvider) SetTimeout(v float32) {
	o.Timeout = &v
}

// GetMode returns the Mode field value if set, zero value otherwise.
func (o *MfaProvider) GetMode() string {
	if o == nil || o.Mode == nil {
		var ret string
		return ret
	}
	return *o.Mode
}

// GetModeOk returns a tuple with the Mode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetModeOk() (*string, bool) {
	if o == nil || o.Mode == nil {
		return nil, false
	}
	return o.Mode, true
}

// HasMode returns a boolean if a field has been set.
func (o *MfaProvider) HasMode() bool {
	if o != nil && o.Mode != nil {
		return true
	}

	return false
}

// SetMode gets a reference to the given string and assigns it to the Mode field.
func (o *MfaProvider) SetMode(v string) {
	o.Mode = &v
}

// GetUseUserPassword returns the UseUserPassword field value if set, zero value otherwise.
func (o *MfaProvider) GetUseUserPassword() bool {
	if o == nil || o.UseUserPassword == nil {
		var ret bool
		return ret
	}
	return *o.UseUserPassword
}

// GetUseUserPasswordOk returns a tuple with the UseUserPassword field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetUseUserPasswordOk() (*bool, bool) {
	if o == nil || o.UseUserPassword == nil {
		return nil, false
	}
	return o.UseUserPassword, true
}

// HasUseUserPassword returns a boolean if a field has been set.
func (o *MfaProvider) HasUseUserPassword() bool {
	if o != nil && o.UseUserPassword != nil {
		return true
	}

	return false
}

// SetUseUserPassword gets a reference to the given bool and assigns it to the UseUserPassword field.
func (o *MfaProvider) SetUseUserPassword(v bool) {
	o.UseUserPassword = &v
}

// GetChallengeSharedSecret returns the ChallengeSharedSecret field value if set, zero value otherwise.
func (o *MfaProvider) GetChallengeSharedSecret() string {
	if o == nil || o.ChallengeSharedSecret == nil {
		var ret string
		return ret
	}
	return *o.ChallengeSharedSecret
}

// GetChallengeSharedSecretOk returns a tuple with the ChallengeSharedSecret field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *MfaProvider) GetChallengeSharedSecretOk() (*string, bool) {
	if o == nil || o.ChallengeSharedSecret == nil {
		return nil, false
	}
	return o.ChallengeSharedSecret, true
}

// HasChallengeSharedSecret returns a boolean if a field has been set.
func (o *MfaProvider) HasChallengeSharedSecret() bool {
	if o != nil && o.ChallengeSharedSecret != nil {
		return true
	}

	return false
}

// SetChallengeSharedSecret gets a reference to the given string and assigns it to the ChallengeSharedSecret field.
func (o *MfaProvider) SetChallengeSharedSecret(v string) {
	o.ChallengeSharedSecret = &v
}

func (o MfaProvider) MarshalJSON() ([]byte, error) {
	toSerialize := map[string]interface{}{}
	if o.Id != nil {
		toSerialize["id"] = o.Id
	}
	if true {
		toSerialize["name"] = o.Name
	}
	if o.Notes != nil {
		toSerialize["notes"] = o.Notes
	}
	if o.Created != nil {
		toSerialize["created"] = o.Created
	}
	if o.Updated != nil {
		toSerialize["updated"] = o.Updated
	}
	if o.Tags != nil {
		toSerialize["tags"] = o.Tags
	}
	if true {
		toSerialize["type"] = o.Type
	}
	if o.Hostnames != nil {
		toSerialize["hostnames"] = o.Hostnames
	}
	if o.Port != nil {
		toSerialize["port"] = o.Port
	}
	if o.InputType != nil {
		toSerialize["inputType"] = o.InputType
	}
	if o.SharedSecret != nil {
		toSerialize["sharedSecret"] = o.SharedSecret
	}
	if o.AuthenticationProtocol != nil {
		toSerialize["authenticationProtocol"] = o.AuthenticationProtocol
	}
	if o.Timeout != nil {
		toSerialize["timeout"] = o.Timeout
	}
	if o.Mode != nil {
		toSerialize["mode"] = o.Mode
	}
	if o.UseUserPassword != nil {
		toSerialize["useUserPassword"] = o.UseUserPassword
	}
	if o.ChallengeSharedSecret != nil {
		toSerialize["challengeSharedSecret"] = o.ChallengeSharedSecret
	}
	return json.Marshal(toSerialize)
}

type NullableMfaProvider struct {
	value *MfaProvider
	isSet bool
}

func (v NullableMfaProvider) Get() *MfaProvider {
	return v.value
}

func (v *NullableMfaProvider) Set(val *MfaProvider) {
	v.value = val
	v.isSet = true
}

func (v NullableMfaProvider) IsSet() bool {
	return v.isSet
}

func (v *NullableMfaProvider) Unset() {
	v.value = nil
	v.isSet = false
}

func NewNullableMfaProvider(val *MfaProvider) *NullableMfaProvider {
	return &NullableMfaProvider{value: val, isSet: true}
}

func (v NullableMfaProvider) MarshalJSON() ([]byte, error) {
	return json.Marshal(v.value)
}

func (v *NullableMfaProvider) UnmarshalJSON(src []byte) error {
	v.isSet = true
	return json.Unmarshal(src, &v.value)
}