/
model_base_identity_provider.go
472 lines (402 loc) · 15.3 KB
/
model_base_identity_provider.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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
/*
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-v19+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 19.2
Contact: appgatesdp.support@appgate.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
"time"
)
// BaseIdentityProvider struct for BaseIdentityProvider
type BaseIdentityProvider 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 Identity Provider.
Type string `json:"type"`
// The IPv4 Pool ID the users in this Identity Provider are going to use to allocate IP addresses for the tunnels.
IpPoolV4 *string `json:"ipPoolV4,omitempty"`
// The IPv6 Pool ID the users in this Identity Provider are going to use to allocate IP addresses for the tunnels.
IpPoolV6 *string `json:"ipPoolV6,omitempty"`
// The mapping of Identity Provider attributes to claims.
ClaimMappings []ClaimMappingsInner `json:"claimMappings,omitempty"`
// ID of the User Claim Scripts to run during authorization.
UserScripts []string `json:"userScripts,omitempty"`
}
// NewBaseIdentityProvider instantiates a new BaseIdentityProvider 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 NewBaseIdentityProvider(name string, type_ string) *BaseIdentityProvider {
this := BaseIdentityProvider{}
this.Name = name
this.Type = type_
return &this
}
// NewBaseIdentityProviderWithDefaults instantiates a new BaseIdentityProvider 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 NewBaseIdentityProviderWithDefaults() *BaseIdentityProvider {
this := BaseIdentityProvider{}
return &this
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) SetId(v string) {
o.Id = &v
}
// GetName returns the Name field value
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) GetNameOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Name, true
}
// SetName sets field value
func (o *BaseIdentityProvider) SetName(v string) {
o.Name = v
}
// GetNotes returns the Notes field value if set, zero value otherwise.
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) SetNotes(v string) {
o.Notes = &v
}
// GetCreated returns the Created field value if set, zero value otherwise.
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) SetCreated(v time.Time) {
o.Created = &v
}
// GetUpdated returns the Updated field value if set, zero value otherwise.
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) SetUpdated(v time.Time) {
o.Updated = &v
}
// GetTags returns the Tags field value if set, zero value otherwise.
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) 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 *BaseIdentityProvider) SetTags(v []string) {
o.Tags = v
}
// GetType returns the Type field value
func (o *BaseIdentityProvider) 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 *BaseIdentityProvider) GetTypeOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Type, true
}
// SetType sets field value
func (o *BaseIdentityProvider) SetType(v string) {
o.Type = v
}
// GetIpPoolV4 returns the IpPoolV4 field value if set, zero value otherwise.
func (o *BaseIdentityProvider) GetIpPoolV4() string {
if o == nil || o.IpPoolV4 == nil {
var ret string
return ret
}
return *o.IpPoolV4
}
// GetIpPoolV4Ok returns a tuple with the IpPoolV4 field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *BaseIdentityProvider) GetIpPoolV4Ok() (*string, bool) {
if o == nil || o.IpPoolV4 == nil {
return nil, false
}
return o.IpPoolV4, true
}
// HasIpPoolV4 returns a boolean if a field has been set.
func (o *BaseIdentityProvider) HasIpPoolV4() bool {
if o != nil && o.IpPoolV4 != nil {
return true
}
return false
}
// SetIpPoolV4 gets a reference to the given string and assigns it to the IpPoolV4 field.
func (o *BaseIdentityProvider) SetIpPoolV4(v string) {
o.IpPoolV4 = &v
}
// GetIpPoolV6 returns the IpPoolV6 field value if set, zero value otherwise.
func (o *BaseIdentityProvider) GetIpPoolV6() string {
if o == nil || o.IpPoolV6 == nil {
var ret string
return ret
}
return *o.IpPoolV6
}
// GetIpPoolV6Ok returns a tuple with the IpPoolV6 field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *BaseIdentityProvider) GetIpPoolV6Ok() (*string, bool) {
if o == nil || o.IpPoolV6 == nil {
return nil, false
}
return o.IpPoolV6, true
}
// HasIpPoolV6 returns a boolean if a field has been set.
func (o *BaseIdentityProvider) HasIpPoolV6() bool {
if o != nil && o.IpPoolV6 != nil {
return true
}
return false
}
// SetIpPoolV6 gets a reference to the given string and assigns it to the IpPoolV6 field.
func (o *BaseIdentityProvider) SetIpPoolV6(v string) {
o.IpPoolV6 = &v
}
// GetClaimMappings returns the ClaimMappings field value if set, zero value otherwise.
func (o *BaseIdentityProvider) GetClaimMappings() []ClaimMappingsInner {
if o == nil || o.ClaimMappings == nil {
var ret []ClaimMappingsInner
return ret
}
return o.ClaimMappings
}
// GetClaimMappingsOk returns a tuple with the ClaimMappings field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *BaseIdentityProvider) GetClaimMappingsOk() ([]ClaimMappingsInner, bool) {
if o == nil || o.ClaimMappings == nil {
return nil, false
}
return o.ClaimMappings, true
}
// HasClaimMappings returns a boolean if a field has been set.
func (o *BaseIdentityProvider) HasClaimMappings() bool {
if o != nil && o.ClaimMappings != nil {
return true
}
return false
}
// SetClaimMappings gets a reference to the given []ClaimMappingsInner and assigns it to the ClaimMappings field.
func (o *BaseIdentityProvider) SetClaimMappings(v []ClaimMappingsInner) {
o.ClaimMappings = v
}
// GetUserScripts returns the UserScripts field value if set, zero value otherwise.
func (o *BaseIdentityProvider) GetUserScripts() []string {
if o == nil || o.UserScripts == nil {
var ret []string
return ret
}
return o.UserScripts
}
// GetUserScriptsOk returns a tuple with the UserScripts field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *BaseIdentityProvider) GetUserScriptsOk() ([]string, bool) {
if o == nil || o.UserScripts == nil {
return nil, false
}
return o.UserScripts, true
}
// HasUserScripts returns a boolean if a field has been set.
func (o *BaseIdentityProvider) HasUserScripts() bool {
if o != nil && o.UserScripts != nil {
return true
}
return false
}
// SetUserScripts gets a reference to the given []string and assigns it to the UserScripts field.
func (o *BaseIdentityProvider) SetUserScripts(v []string) {
o.UserScripts = v
}
func (o BaseIdentityProvider) 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.IpPoolV4 != nil {
toSerialize["ipPoolV4"] = o.IpPoolV4
}
if o.IpPoolV6 != nil {
toSerialize["ipPoolV6"] = o.IpPoolV6
}
if o.ClaimMappings != nil {
toSerialize["claimMappings"] = o.ClaimMappings
}
if o.UserScripts != nil {
toSerialize["userScripts"] = o.UserScripts
}
return json.Marshal(toSerialize)
}
type NullableBaseIdentityProvider struct {
value *BaseIdentityProvider
isSet bool
}
func (v NullableBaseIdentityProvider) Get() *BaseIdentityProvider {
return v.value
}
func (v *NullableBaseIdentityProvider) Set(val *BaseIdentityProvider) {
v.value = val
v.isSet = true
}
func (v NullableBaseIdentityProvider) IsSet() bool {
return v.isSet
}
func (v *NullableBaseIdentityProvider) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableBaseIdentityProvider(val *BaseIdentityProvider) *NullableBaseIdentityProvider {
return &NullableBaseIdentityProvider{value: val, isSet: true}
}
func (v NullableBaseIdentityProvider) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableBaseIdentityProvider) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}