-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodel_enrollment_report.go
521 lines (442 loc) · 20.2 KB
/
model_enrollment_report.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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
/*
Enterprise PKI Manager REST API
Welcome to the DigiCert ONE Enterprise PKI Manager REST API. The Enterprise PKI Manager API service provides operations for managing enrollments and certificates for users and devices, retrieving certificate profiles and seats, and account event reporting. ## Base URL The base URL path for endpoints in the Enterprise PKI Manager REST API is: `{server}/mpki/api/v1`. Replace `{server}` with the hostname of your DigiCert ONE instance. For example, if you are using the DigiCert ONE hosted cloud solution, your `{server}` is `https://one.digicert.com`. ## Authentication API clients can authenticate to endpoints in the Enterprise PKI Manager REST API using these methods: * Header-based API token authentication. * Authentication using a client authentication certificate. ### API token To authenticate with an API token, include the custom HTTP header `x-api-key` in your request. Use one of these values in the `x-api-key` header: * A Service user token ID (**recommended**). * An API token bound to a DigiCert ONE administrator. **Note:** We recommend that you dedicate a Service user token ID to API operations as this distinguishes API requests from administrator actions in your account audit logs. **Service user token ID** * Service users are API tokens that are not associated with a specific user. * When you create a service user, you assign only the permissions needed for the API integration. * There are two ways to create a new service user: * 1- Use the Account Manager in DigiCert ONE: 1. Navigate to the DigiCert ONE **Account Manager**. 2. Select **Access** from the left menu. 3. Select **Service User** from the left menu. 4. Select **Create service user** and follow the remaining prompts. * 2- Make a request to the `/account/api/v1/user` endpoint in the DigiCert ONE Account Manager API service. **Administrator API token** * Standard users (administrators) can create API tokens in DigiCert ONE. * API tokens have the same permissions and access scope as the administrator that created them. * Actions linked to the API token are logged under the administrator's name in event audit logs. * To generate a new API token: 1. Navigate to the DigiCert ONE **Account Manager**. 2. Select **Access** from the left menu. 3. Select **Administrators**. 4. Select the administrator you wish to create an API token for from the list. 5. Scroll down to the **API Tokens** section on the administrator page. 6. Select **Create API token** and follow the remaining prompts. ### Client authentication certificate When authenticating with a client authentication certificate, you present a trusted certificate in your request. Both DigiCert ONE administrators and service users can use client authentication certificates. To generate a client authentication certificate: 1. Navigate to the DigiCert ONE **Account Manager**. 2. Select **Access** from the left menu. 3. Search for and select your Service user. 4. Scroll to the **Authentication certificates** section and select **Create authentication certificate**. 5. Enter a **Nickname** and select an **End date** for the certificate. 6. Select **Generate certificate**. Copy the password that is displayed (this is only displayed once and is required to decrypt the PKCS12 certificate file) and select **Download certificate**. 7. Confirm that you have downloaded the certificate file (**Certificate_pkcs12.p12**) and that you can successfully decrypt it with the provided password, then click **Close** in the certificate download dialog box. 8. Review the permissions you wish to provide to the Service user that the certificate is associated with. **Note**: We recommend that you assign permissions according to the principle of least privilege, i.e. you assign the minimum permissions needed to perform the required tasks. To use a client authentication certificate: * Include the certificate in your API request. * In the base URL for the endpoint path, add the prefix `clientauth`. For example: `https://clientauth.one.digicert.com` * Omit the `x-api-key` header. ## Requests The Enterprise PKI Manager API service accepts REST calls on HTTP/HTTPS ports 80/443. All requests are submitted using RESTful URLs and REST features, including header-based authentication and JSON request types. The data character set encoding for requests is UTF-8. A well-formed request uses port 443 and specifies the user-agent and content-length HTTP headers. Each request consists of a method and an endpoint. Some requests also include a request payload if relevant to the operation being performed. ### Method The Enterprise PKI Manager API uses these standard HTTP methods: * GET * POST * PUT * DELETE ### Body and content type All requests that accept a body require passing in JSON formatted data with the `Content-Type` header set to `application/json`. GET requests do not require passing formatted data in the request payload. However, some GET operations allow you to filter the results by providing additional path parameters or URL query strings (appended to the endpoint URL, e.g. `?limit=50`). ## Responses Each response consists of a header and a body. The body is formatted based on the content type requested in the `Accept` header. **Note:** Enterprise PKI Manager API endpoints only support responses with a content type of `application/json`. Requests that use the `Accept` header to specify a different content type will fail. ### Headers Each response includes a header with a response code based on [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1) specifications. * HTTP codes in the **200-399** range describe a successful request. Response bodies for HTTP codes in this range include the response data associated with the operation. * HTTP codes in the **400+** range describe an error. Unsuccessful requests return a list with one or more `errors`. Each error object includes a `code` and a `message` describing the problem with the request. **Example error response** ```JSON { \"error\": { \"code\": \"no_access\", \"message\": \"User has no access to the Business unit with id = xxxxx or such Business unit does not exist\" } } ```
API version: 1.0.0
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// EnrollmentReport struct for EnrollmentReport
type EnrollmentReport struct {
Seat *NameDto `json:"seat,omitempty"`
// Type of Seat to which this Enrollment is linked
SeatType *string `json:"seatType,omitempty"`
// Name of Profile against which Enrollment was issued
ProfileName *string `json:"profileName,omitempty"`
// Name of Business unit to which Enrollment is linked
BuName *string `json:"buName,omitempty"`
// Subject of Enrollment
Subject *string `json:"subject,omitempty"`
// Current status of Enrollment
EnrollmentStatus *string `json:"enrollmentStatus,omitempty"`
// Date when Enrollment was created in format YYYY-MM-DD
CreateDate *string `json:"createDate,omitempty"`
// Date when Enrollment should be (was) expired in format YYYY-MM-DD
ExpiryDate *string `json:"expiryDate,omitempty"`
// Date when Enrollment was redeemed in format YYYY-MM-DD
RedeemDate *string `json:"redeemDate,omitempty"`
// Date when Enrollment was rejected in format YYYY-MM-DD
RejectDate *string `json:"rejectDate,omitempty"`
// Date when Enrollment was last edited in format YYYY-MM-DD
LastEditDate *string `json:"lastEditDate,omitempty"`
LastEditAdmin *NameDto `json:"lastEditAdmin,omitempty"`
}
// NewEnrollmentReport instantiates a new EnrollmentReport 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 NewEnrollmentReport() *EnrollmentReport {
this := EnrollmentReport{}
return &this
}
// NewEnrollmentReportWithDefaults instantiates a new EnrollmentReport 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 NewEnrollmentReportWithDefaults() *EnrollmentReport {
this := EnrollmentReport{}
return &this
}
// GetSeat returns the Seat field value if set, zero value otherwise.
func (o *EnrollmentReport) GetSeat() NameDto {
if o == nil || o.Seat == nil {
var ret NameDto
return ret
}
return *o.Seat
}
// GetSeatOk returns a tuple with the Seat field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetSeatOk() (*NameDto, bool) {
if o == nil || o.Seat == nil {
return nil, false
}
return o.Seat, true
}
// HasSeat returns a boolean if a field has been set.
func (o *EnrollmentReport) HasSeat() bool {
if o != nil && o.Seat != nil {
return true
}
return false
}
// SetSeat gets a reference to the given NameDto and assigns it to the Seat field.
func (o *EnrollmentReport) SetSeat(v NameDto) {
o.Seat = &v
}
// GetSeatType returns the SeatType field value if set, zero value otherwise.
func (o *EnrollmentReport) GetSeatType() string {
if o == nil || o.SeatType == nil {
var ret string
return ret
}
return *o.SeatType
}
// GetSeatTypeOk returns a tuple with the SeatType field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetSeatTypeOk() (*string, bool) {
if o == nil || o.SeatType == nil {
return nil, false
}
return o.SeatType, true
}
// HasSeatType returns a boolean if a field has been set.
func (o *EnrollmentReport) HasSeatType() bool {
if o != nil && o.SeatType != nil {
return true
}
return false
}
// SetSeatType gets a reference to the given string and assigns it to the SeatType field.
func (o *EnrollmentReport) SetSeatType(v string) {
o.SeatType = &v
}
// GetProfileName returns the ProfileName field value if set, zero value otherwise.
func (o *EnrollmentReport) GetProfileName() string {
if o == nil || o.ProfileName == nil {
var ret string
return ret
}
return *o.ProfileName
}
// GetProfileNameOk returns a tuple with the ProfileName field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetProfileNameOk() (*string, bool) {
if o == nil || o.ProfileName == nil {
return nil, false
}
return o.ProfileName, true
}
// HasProfileName returns a boolean if a field has been set.
func (o *EnrollmentReport) HasProfileName() bool {
if o != nil && o.ProfileName != nil {
return true
}
return false
}
// SetProfileName gets a reference to the given string and assigns it to the ProfileName field.
func (o *EnrollmentReport) SetProfileName(v string) {
o.ProfileName = &v
}
// GetBuName returns the BuName field value if set, zero value otherwise.
func (o *EnrollmentReport) GetBuName() string {
if o == nil || o.BuName == nil {
var ret string
return ret
}
return *o.BuName
}
// GetBuNameOk returns a tuple with the BuName field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetBuNameOk() (*string, bool) {
if o == nil || o.BuName == nil {
return nil, false
}
return o.BuName, true
}
// HasBuName returns a boolean if a field has been set.
func (o *EnrollmentReport) HasBuName() bool {
if o != nil && o.BuName != nil {
return true
}
return false
}
// SetBuName gets a reference to the given string and assigns it to the BuName field.
func (o *EnrollmentReport) SetBuName(v string) {
o.BuName = &v
}
// GetSubject returns the Subject field value if set, zero value otherwise.
func (o *EnrollmentReport) GetSubject() string {
if o == nil || o.Subject == nil {
var ret string
return ret
}
return *o.Subject
}
// GetSubjectOk returns a tuple with the Subject field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetSubjectOk() (*string, bool) {
if o == nil || o.Subject == nil {
return nil, false
}
return o.Subject, true
}
// HasSubject returns a boolean if a field has been set.
func (o *EnrollmentReport) HasSubject() bool {
if o != nil && o.Subject != nil {
return true
}
return false
}
// SetSubject gets a reference to the given string and assigns it to the Subject field.
func (o *EnrollmentReport) SetSubject(v string) {
o.Subject = &v
}
// GetEnrollmentStatus returns the EnrollmentStatus field value if set, zero value otherwise.
func (o *EnrollmentReport) GetEnrollmentStatus() string {
if o == nil || o.EnrollmentStatus == nil {
var ret string
return ret
}
return *o.EnrollmentStatus
}
// GetEnrollmentStatusOk returns a tuple with the EnrollmentStatus field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetEnrollmentStatusOk() (*string, bool) {
if o == nil || o.EnrollmentStatus == nil {
return nil, false
}
return o.EnrollmentStatus, true
}
// HasEnrollmentStatus returns a boolean if a field has been set.
func (o *EnrollmentReport) HasEnrollmentStatus() bool {
if o != nil && o.EnrollmentStatus != nil {
return true
}
return false
}
// SetEnrollmentStatus gets a reference to the given string and assigns it to the EnrollmentStatus field.
func (o *EnrollmentReport) SetEnrollmentStatus(v string) {
o.EnrollmentStatus = &v
}
// GetCreateDate returns the CreateDate field value if set, zero value otherwise.
func (o *EnrollmentReport) GetCreateDate() string {
if o == nil || o.CreateDate == nil {
var ret string
return ret
}
return *o.CreateDate
}
// GetCreateDateOk returns a tuple with the CreateDate field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetCreateDateOk() (*string, bool) {
if o == nil || o.CreateDate == nil {
return nil, false
}
return o.CreateDate, true
}
// HasCreateDate returns a boolean if a field has been set.
func (o *EnrollmentReport) HasCreateDate() bool {
if o != nil && o.CreateDate != nil {
return true
}
return false
}
// SetCreateDate gets a reference to the given string and assigns it to the CreateDate field.
func (o *EnrollmentReport) SetCreateDate(v string) {
o.CreateDate = &v
}
// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise.
func (o *EnrollmentReport) GetExpiryDate() string {
if o == nil || o.ExpiryDate == nil {
var ret string
return ret
}
return *o.ExpiryDate
}
// GetExpiryDateOk returns a tuple with the ExpiryDate field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetExpiryDateOk() (*string, bool) {
if o == nil || o.ExpiryDate == nil {
return nil, false
}
return o.ExpiryDate, true
}
// HasExpiryDate returns a boolean if a field has been set.
func (o *EnrollmentReport) HasExpiryDate() bool {
if o != nil && o.ExpiryDate != nil {
return true
}
return false
}
// SetExpiryDate gets a reference to the given string and assigns it to the ExpiryDate field.
func (o *EnrollmentReport) SetExpiryDate(v string) {
o.ExpiryDate = &v
}
// GetRedeemDate returns the RedeemDate field value if set, zero value otherwise.
func (o *EnrollmentReport) GetRedeemDate() string {
if o == nil || o.RedeemDate == nil {
var ret string
return ret
}
return *o.RedeemDate
}
// GetRedeemDateOk returns a tuple with the RedeemDate field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetRedeemDateOk() (*string, bool) {
if o == nil || o.RedeemDate == nil {
return nil, false
}
return o.RedeemDate, true
}
// HasRedeemDate returns a boolean if a field has been set.
func (o *EnrollmentReport) HasRedeemDate() bool {
if o != nil && o.RedeemDate != nil {
return true
}
return false
}
// SetRedeemDate gets a reference to the given string and assigns it to the RedeemDate field.
func (o *EnrollmentReport) SetRedeemDate(v string) {
o.RedeemDate = &v
}
// GetRejectDate returns the RejectDate field value if set, zero value otherwise.
func (o *EnrollmentReport) GetRejectDate() string {
if o == nil || o.RejectDate == nil {
var ret string
return ret
}
return *o.RejectDate
}
// GetRejectDateOk returns a tuple with the RejectDate field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetRejectDateOk() (*string, bool) {
if o == nil || o.RejectDate == nil {
return nil, false
}
return o.RejectDate, true
}
// HasRejectDate returns a boolean if a field has been set.
func (o *EnrollmentReport) HasRejectDate() bool {
if o != nil && o.RejectDate != nil {
return true
}
return false
}
// SetRejectDate gets a reference to the given string and assigns it to the RejectDate field.
func (o *EnrollmentReport) SetRejectDate(v string) {
o.RejectDate = &v
}
// GetLastEditDate returns the LastEditDate field value if set, zero value otherwise.
func (o *EnrollmentReport) GetLastEditDate() string {
if o == nil || o.LastEditDate == nil {
var ret string
return ret
}
return *o.LastEditDate
}
// GetLastEditDateOk returns a tuple with the LastEditDate field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetLastEditDateOk() (*string, bool) {
if o == nil || o.LastEditDate == nil {
return nil, false
}
return o.LastEditDate, true
}
// HasLastEditDate returns a boolean if a field has been set.
func (o *EnrollmentReport) HasLastEditDate() bool {
if o != nil && o.LastEditDate != nil {
return true
}
return false
}
// SetLastEditDate gets a reference to the given string and assigns it to the LastEditDate field.
func (o *EnrollmentReport) SetLastEditDate(v string) {
o.LastEditDate = &v
}
// GetLastEditAdmin returns the LastEditAdmin field value if set, zero value otherwise.
func (o *EnrollmentReport) GetLastEditAdmin() NameDto {
if o == nil || o.LastEditAdmin == nil {
var ret NameDto
return ret
}
return *o.LastEditAdmin
}
// GetLastEditAdminOk returns a tuple with the LastEditAdmin field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *EnrollmentReport) GetLastEditAdminOk() (*NameDto, bool) {
if o == nil || o.LastEditAdmin == nil {
return nil, false
}
return o.LastEditAdmin, true
}
// HasLastEditAdmin returns a boolean if a field has been set.
func (o *EnrollmentReport) HasLastEditAdmin() bool {
if o != nil && o.LastEditAdmin != nil {
return true
}
return false
}
// SetLastEditAdmin gets a reference to the given NameDto and assigns it to the LastEditAdmin field.
func (o *EnrollmentReport) SetLastEditAdmin(v NameDto) {
o.LastEditAdmin = &v
}
func (o EnrollmentReport) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Seat != nil {
toSerialize["seat"] = o.Seat
}
if o.SeatType != nil {
toSerialize["seatType"] = o.SeatType
}
if o.ProfileName != nil {
toSerialize["profileName"] = o.ProfileName
}
if o.BuName != nil {
toSerialize["buName"] = o.BuName
}
if o.Subject != nil {
toSerialize["subject"] = o.Subject
}
if o.EnrollmentStatus != nil {
toSerialize["enrollmentStatus"] = o.EnrollmentStatus
}
if o.CreateDate != nil {
toSerialize["createDate"] = o.CreateDate
}
if o.ExpiryDate != nil {
toSerialize["expiryDate"] = o.ExpiryDate
}
if o.RedeemDate != nil {
toSerialize["redeemDate"] = o.RedeemDate
}
if o.RejectDate != nil {
toSerialize["rejectDate"] = o.RejectDate
}
if o.LastEditDate != nil {
toSerialize["lastEditDate"] = o.LastEditDate
}
if o.LastEditAdmin != nil {
toSerialize["lastEditAdmin"] = o.LastEditAdmin
}
return json.Marshal(toSerialize)
}
type NullableEnrollmentReport struct {
value *EnrollmentReport
isSet bool
}
func (v NullableEnrollmentReport) Get() *EnrollmentReport {
return v.value
}
func (v *NullableEnrollmentReport) Set(val *EnrollmentReport) {
v.value = val
v.isSet = true
}
func (v NullableEnrollmentReport) IsSet() bool {
return v.isSet
}
func (v *NullableEnrollmentReport) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableEnrollmentReport(val *EnrollmentReport) *NullableEnrollmentReport {
return &NullableEnrollmentReport{value: val, isSet: true}
}
func (v NullableEnrollmentReport) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableEnrollmentReport) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}