/
model__authentication_otp_initialize_post_request.go
115 lines (93 loc) · 6.83 KB
/
model__authentication_otp_initialize_post_request.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
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-v18+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 18.5
Contact: appgatesdp.support@appgate.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// AuthenticationOtpInitializePostRequest struct for AuthenticationOtpInitializePostRequest
type AuthenticationOtpInitializePostRequest struct {
// Some MFA configurations require user password in order to authenticate the user along with the multi-factor. Otherwise not required.
UserPassword *string `json:"userPassword,omitempty"`
}
// NewAuthenticationOtpInitializePostRequest instantiates a new AuthenticationOtpInitializePostRequest 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 NewAuthenticationOtpInitializePostRequest() *AuthenticationOtpInitializePostRequest {
this := AuthenticationOtpInitializePostRequest{}
return &this
}
// NewAuthenticationOtpInitializePostRequestWithDefaults instantiates a new AuthenticationOtpInitializePostRequest 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 NewAuthenticationOtpInitializePostRequestWithDefaults() *AuthenticationOtpInitializePostRequest {
this := AuthenticationOtpInitializePostRequest{}
return &this
}
// GetUserPassword returns the UserPassword field value if set, zero value otherwise.
func (o *AuthenticationOtpInitializePostRequest) GetUserPassword() string {
if o == nil || o.UserPassword == nil {
var ret string
return ret
}
return *o.UserPassword
}
// GetUserPasswordOk returns a tuple with the UserPassword field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *AuthenticationOtpInitializePostRequest) GetUserPasswordOk() (*string, bool) {
if o == nil || o.UserPassword == nil {
return nil, false
}
return o.UserPassword, true
}
// HasUserPassword returns a boolean if a field has been set.
func (o *AuthenticationOtpInitializePostRequest) HasUserPassword() bool {
if o != nil && o.UserPassword != nil {
return true
}
return false
}
// SetUserPassword gets a reference to the given string and assigns it to the UserPassword field.
func (o *AuthenticationOtpInitializePostRequest) SetUserPassword(v string) {
o.UserPassword = &v
}
func (o AuthenticationOtpInitializePostRequest) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.UserPassword != nil {
toSerialize["userPassword"] = o.UserPassword
}
return json.Marshal(toSerialize)
}
type NullableAuthenticationOtpInitializePostRequest struct {
value *AuthenticationOtpInitializePostRequest
isSet bool
}
func (v NullableAuthenticationOtpInitializePostRequest) Get() *AuthenticationOtpInitializePostRequest {
return v.value
}
func (v *NullableAuthenticationOtpInitializePostRequest) Set(val *AuthenticationOtpInitializePostRequest) {
v.value = val
v.isSet = true
}
func (v NullableAuthenticationOtpInitializePostRequest) IsSet() bool {
return v.isSet
}
func (v *NullableAuthenticationOtpInitializePostRequest) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableAuthenticationOtpInitializePostRequest(val *AuthenticationOtpInitializePostRequest) *NullableAuthenticationOtpInitializePostRequest {
return &NullableAuthenticationOtpInitializePostRequest{value: val, isSet: true}
}
func (v NullableAuthenticationOtpInitializePostRequest) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableAuthenticationOtpInitializePostRequest) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}