/
model_login_request.go
249 lines (211 loc) · 9.44 KB
/
model_login_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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
/*
* AppGate SDP Controller REST API
*
* # About This specification documents the REST API calls for the AppGate SDP Controller. Please refer to the Integration chapter in the manual or contact AppGate support with any questions about this functionality. # Getting Started Requirements for API scripting: - Access to the peer interface (default port 444) of a Controller appliance. (https://sdphelp.appgate.com/adminguide/appliances-configure.html?anchor=peer) - 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 Peer Interface hostname and port, with **_/admin** path. For example: **https://appgate.company.com:444/admin** All requests must have the **Accept** header as: **application/vnd.appgate.peer-v13+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, if 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 recommend 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 13
* Contact: appgatesdp.support@appgate.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// LoginRequest struct for LoginRequest
type LoginRequest struct {
// Display name of the Identity Provider name.
ProviderName string `json:"providerName"`
// Username. Required if a credentials based Identity Provider is used.
Username *string `json:"username,omitempty"`
// Password. Required if a credentials based Identity Provider is used.
Password *string `json:"password,omitempty"`
// UUID to distinguish the Client device making the request. It is supposed to be same for every login request from the same server.
DeviceId string `json:"deviceId"`
// SAMLResponse received from SAML provider. Required if a SAML based Identity Provider is used.
SamlResponse *string `json:"samlResponse,omitempty"`
}
// NewLoginRequest instantiates a new LoginRequest 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 NewLoginRequest(providerName string, deviceId string) *LoginRequest {
this := LoginRequest{}
this.ProviderName = providerName
this.DeviceId = deviceId
return &this
}
// NewLoginRequestWithDefaults instantiates a new LoginRequest 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 NewLoginRequestWithDefaults() *LoginRequest {
this := LoginRequest{}
return &this
}
// GetProviderName returns the ProviderName field value
func (o *LoginRequest) GetProviderName() string {
if o == nil {
var ret string
return ret
}
return o.ProviderName
}
// GetProviderNameOk returns a tuple with the ProviderName field value
// and a boolean to check if the value has been set.
func (o *LoginRequest) GetProviderNameOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.ProviderName, true
}
// SetProviderName sets field value
func (o *LoginRequest) SetProviderName(v string) {
o.ProviderName = v
}
// GetUsername returns the Username field value if set, zero value otherwise.
func (o *LoginRequest) GetUsername() string {
if o == nil || o.Username == nil {
var ret string
return ret
}
return *o.Username
}
// GetUsernameOk returns a tuple with the Username field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *LoginRequest) GetUsernameOk() (*string, bool) {
if o == nil || o.Username == nil {
return nil, false
}
return o.Username, true
}
// HasUsername returns a boolean if a field has been set.
func (o *LoginRequest) HasUsername() bool {
if o != nil && o.Username != nil {
return true
}
return false
}
// SetUsername gets a reference to the given string and assigns it to the Username field.
func (o *LoginRequest) SetUsername(v string) {
o.Username = &v
}
// GetPassword returns the Password field value if set, zero value otherwise.
func (o *LoginRequest) GetPassword() string {
if o == nil || o.Password == nil {
var ret string
return ret
}
return *o.Password
}
// GetPasswordOk returns a tuple with the Password field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *LoginRequest) GetPasswordOk() (*string, bool) {
if o == nil || o.Password == nil {
return nil, false
}
return o.Password, true
}
// HasPassword returns a boolean if a field has been set.
func (o *LoginRequest) HasPassword() bool {
if o != nil && o.Password != nil {
return true
}
return false
}
// SetPassword gets a reference to the given string and assigns it to the Password field.
func (o *LoginRequest) SetPassword(v string) {
o.Password = &v
}
// GetDeviceId returns the DeviceId field value
func (o *LoginRequest) GetDeviceId() string {
if o == nil {
var ret string
return ret
}
return o.DeviceId
}
// GetDeviceIdOk returns a tuple with the DeviceId field value
// and a boolean to check if the value has been set.
func (o *LoginRequest) GetDeviceIdOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.DeviceId, true
}
// SetDeviceId sets field value
func (o *LoginRequest) SetDeviceId(v string) {
o.DeviceId = v
}
// GetSamlResponse returns the SamlResponse field value if set, zero value otherwise.
func (o *LoginRequest) GetSamlResponse() string {
if o == nil || o.SamlResponse == nil {
var ret string
return ret
}
return *o.SamlResponse
}
// GetSamlResponseOk returns a tuple with the SamlResponse field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *LoginRequest) GetSamlResponseOk() (*string, bool) {
if o == nil || o.SamlResponse == nil {
return nil, false
}
return o.SamlResponse, true
}
// HasSamlResponse returns a boolean if a field has been set.
func (o *LoginRequest) HasSamlResponse() bool {
if o != nil && o.SamlResponse != nil {
return true
}
return false
}
// SetSamlResponse gets a reference to the given string and assigns it to the SamlResponse field.
func (o *LoginRequest) SetSamlResponse(v string) {
o.SamlResponse = &v
}
func (o LoginRequest) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if true {
toSerialize["providerName"] = o.ProviderName
}
if o.Username != nil {
toSerialize["username"] = o.Username
}
if o.Password != nil {
toSerialize["password"] = o.Password
}
if true {
toSerialize["deviceId"] = o.DeviceId
}
if o.SamlResponse != nil {
toSerialize["samlResponse"] = o.SamlResponse
}
return json.Marshal(toSerialize)
}
type NullableLoginRequest struct {
value *LoginRequest
isSet bool
}
func (v NullableLoginRequest) Get() *LoginRequest {
return v.value
}
func (v *NullableLoginRequest) Set(val *LoginRequest) {
v.value = val
v.isSet = true
}
func (v NullableLoginRequest) IsSet() bool {
return v.isSet
}
func (v *NullableLoginRequest) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableLoginRequest(val *LoginRequest) *NullableLoginRequest {
return &NullableLoginRequest{value: val, isSet: true}
}
func (v NullableLoginRequest) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableLoginRequest) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}