-
Notifications
You must be signed in to change notification settings - Fork 541
/
token.go
648 lines (551 loc) · 18.9 KB
/
token.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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package user
import (
"context"
"fmt"
"net/http"
"net/url"
"reflect"
"time"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/apiquery"
"github.com/cloudflare/cloudflare-go/v2/internal/pagination"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
"github.com/cloudflare/cloudflare-go/v2/shared"
"github.com/tidwall/gjson"
)
// TokenService contains methods and other services that help with interacting with
// the cloudflare API. Note, unlike clients, this service does not read variables
// from the environment automatically. You should not instantiate this service
// directly, and instead use the [NewTokenService] method instead.
type TokenService struct {
Options []option.RequestOption
PermissionGroups *TokenPermissionGroupService
Value *TokenValueService
}
// NewTokenService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewTokenService(opts ...option.RequestOption) (r *TokenService) {
r = &TokenService{}
r.Options = opts
r.PermissionGroups = NewTokenPermissionGroupService(opts...)
r.Value = NewTokenValueService(opts...)
return
}
// Create a new access token.
func (r *TokenService) New(ctx context.Context, body TokenNewParams, opts ...option.RequestOption) (res *TokenNewResponse, err error) {
opts = append(r.Options[:], opts...)
var env TokenNewResponseEnvelope
path := "user/tokens"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Update an existing token.
func (r *TokenService) Update(ctx context.Context, tokenID interface{}, body TokenUpdateParams, opts ...option.RequestOption) (res *TokenUpdateResponseUnion, err error) {
opts = append(r.Options[:], opts...)
var env TokenUpdateResponseEnvelope
path := fmt.Sprintf("user/tokens/%v", tokenID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPut, path, body, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// List all access tokens you created.
func (r *TokenService) List(ctx context.Context, query TokenListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[TokenListResponse], err error) {
var raw *http.Response
opts = append(r.Options, opts...)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "user/tokens"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// List all access tokens you created.
func (r *TokenService) ListAutoPaging(ctx context.Context, query TokenListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[TokenListResponse] {
return pagination.NewV4PagePaginationArrayAutoPager(r.List(ctx, query, opts...))
}
// Destroy a token.
func (r *TokenService) Delete(ctx context.Context, tokenID interface{}, opts ...option.RequestOption) (res *TokenDeleteResponse, err error) {
opts = append(r.Options[:], opts...)
var env TokenDeleteResponseEnvelope
path := fmt.Sprintf("user/tokens/%v", tokenID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Get information about a specific token.
func (r *TokenService) Get(ctx context.Context, tokenID interface{}, opts ...option.RequestOption) (res *TokenGetResponseUnion, err error) {
opts = append(r.Options[:], opts...)
var env TokenGetResponseEnvelope
path := fmt.Sprintf("user/tokens/%v", tokenID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Test whether a token works.
func (r *TokenService) Verify(ctx context.Context, opts ...option.RequestOption) (res *TokenVerifyResponse, err error) {
opts = append(r.Options[:], opts...)
var env TokenVerifyResponseEnvelope
path := "user/tokens/verify"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type CIDRListParam = string
type PolicyParam struct {
// Allow or deny operations against the resources.
Effect param.Field[PolicyEffect] `json:"effect,required"`
// A set of permission groups that are specified to the policy.
PermissionGroups param.Field[[]PolicyPermissionGroupParam] `json:"permission_groups,required"`
// A list of resource names that the policy applies to.
Resources param.Field[interface{}] `json:"resources,required"`
}
func (r PolicyParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Allow or deny operations against the resources.
type PolicyEffect string
const (
PolicyEffectAllow PolicyEffect = "allow"
PolicyEffectDeny PolicyEffect = "deny"
)
func (r PolicyEffect) IsKnown() bool {
switch r {
case PolicyEffectAllow, PolicyEffectDeny:
return true
}
return false
}
// A named group of permissions that map to a group of operations against
// resources.
type PolicyPermissionGroupParam struct {
}
func (r PolicyPermissionGroupParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type TokenParam struct {
// Token name.
Name param.Field[string] `json:"name,required"`
// List of access policies assigned to the token.
Policies param.Field[[]PolicyParam] `json:"policies,required"`
// Status of the token.
Status param.Field[TokenStatus] `json:"status,required"`
Condition param.Field[TokenConditionParam] `json:"condition"`
// The expiration time on or after which the JWT MUST NOT be accepted for
// processing.
ExpiresOn param.Field[time.Time] `json:"expires_on" format:"date-time"`
// The time before which the token MUST NOT be accepted for processing.
NotBefore param.Field[time.Time] `json:"not_before" format:"date-time"`
}
func (r TokenParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Status of the token.
type TokenStatus string
const (
TokenStatusActive TokenStatus = "active"
TokenStatusDisabled TokenStatus = "disabled"
TokenStatusExpired TokenStatus = "expired"
)
func (r TokenStatus) IsKnown() bool {
switch r {
case TokenStatusActive, TokenStatusDisabled, TokenStatusExpired:
return true
}
return false
}
type TokenConditionParam struct {
// Client IP restrictions.
RequestIP param.Field[TokenConditionRequestIPParam] `json:"request_ip"`
}
func (r TokenConditionParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Client IP restrictions.
type TokenConditionRequestIPParam struct {
// List of IPv4/IPv6 CIDR addresses.
In param.Field[[]CIDRListParam] `json:"in"`
// List of IPv4/IPv6 CIDR addresses.
NotIn param.Field[[]CIDRListParam] `json:"not_in"`
}
func (r TokenConditionRequestIPParam) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type TokenNewResponse struct {
// The token value.
Value Value `json:"value"`
JSON tokenNewResponseJSON `json:"-"`
}
// tokenNewResponseJSON contains the JSON metadata for the struct
// [TokenNewResponse]
type tokenNewResponseJSON struct {
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenNewResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenNewResponseJSON) RawJSON() string {
return r.raw
}
// Union satisfied by [user.TokenUpdateResponseUnknown] or [shared.UnionString].
type TokenUpdateResponseUnion interface {
ImplementsUserTokenUpdateResponseUnion()
}
func init() {
apijson.RegisterUnion(
reflect.TypeOf((*TokenUpdateResponseUnion)(nil)).Elem(),
"",
apijson.UnionVariant{
TypeFilter: gjson.String,
Type: reflect.TypeOf(shared.UnionString("")),
},
)
}
type TokenListResponse = interface{}
type TokenDeleteResponse struct {
// Identifier
ID string `json:"id,required"`
JSON tokenDeleteResponseJSON `json:"-"`
}
// tokenDeleteResponseJSON contains the JSON metadata for the struct
// [TokenDeleteResponse]
type tokenDeleteResponseJSON struct {
ID apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenDeleteResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenDeleteResponseJSON) RawJSON() string {
return r.raw
}
// Union satisfied by [user.TokenGetResponseUnknown] or [shared.UnionString].
type TokenGetResponseUnion interface {
ImplementsUserTokenGetResponseUnion()
}
func init() {
apijson.RegisterUnion(
reflect.TypeOf((*TokenGetResponseUnion)(nil)).Elem(),
"",
apijson.UnionVariant{
TypeFilter: gjson.String,
Type: reflect.TypeOf(shared.UnionString("")),
},
)
}
type TokenVerifyResponse struct {
// Token identifier tag.
ID string `json:"id,required"`
// Status of the token.
Status TokenVerifyResponseStatus `json:"status,required"`
// The expiration time on or after which the JWT MUST NOT be accepted for
// processing.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The time before which the token MUST NOT be accepted for processing.
NotBefore time.Time `json:"not_before" format:"date-time"`
JSON tokenVerifyResponseJSON `json:"-"`
}
// tokenVerifyResponseJSON contains the JSON metadata for the struct
// [TokenVerifyResponse]
type tokenVerifyResponseJSON struct {
ID apijson.Field
Status apijson.Field
ExpiresOn apijson.Field
NotBefore apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenVerifyResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenVerifyResponseJSON) RawJSON() string {
return r.raw
}
// Status of the token.
type TokenVerifyResponseStatus string
const (
TokenVerifyResponseStatusActive TokenVerifyResponseStatus = "active"
TokenVerifyResponseStatusDisabled TokenVerifyResponseStatus = "disabled"
TokenVerifyResponseStatusExpired TokenVerifyResponseStatus = "expired"
)
func (r TokenVerifyResponseStatus) IsKnown() bool {
switch r {
case TokenVerifyResponseStatusActive, TokenVerifyResponseStatusDisabled, TokenVerifyResponseStatusExpired:
return true
}
return false
}
type TokenNewParams struct {
// Token name.
Name param.Field[string] `json:"name,required"`
// List of access policies assigned to the token.
Policies param.Field[[]PolicyParam] `json:"policies,required"`
Condition param.Field[TokenNewParamsCondition] `json:"condition"`
// The expiration time on or after which the JWT MUST NOT be accepted for
// processing.
ExpiresOn param.Field[time.Time] `json:"expires_on" format:"date-time"`
// The time before which the token MUST NOT be accepted for processing.
NotBefore param.Field[time.Time] `json:"not_before" format:"date-time"`
}
func (r TokenNewParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type TokenNewParamsCondition struct {
// Client IP restrictions.
RequestIP param.Field[TokenNewParamsConditionRequestIP] `json:"request_ip"`
}
func (r TokenNewParamsCondition) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Client IP restrictions.
type TokenNewParamsConditionRequestIP struct {
// List of IPv4/IPv6 CIDR addresses.
In param.Field[[]CIDRListParam] `json:"in"`
// List of IPv4/IPv6 CIDR addresses.
NotIn param.Field[[]CIDRListParam] `json:"not_in"`
}
func (r TokenNewParamsConditionRequestIP) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type TokenNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result TokenNewResponse `json:"result,required"`
// Whether the API call was successful
Success TokenNewResponseEnvelopeSuccess `json:"success,required"`
JSON tokenNewResponseEnvelopeJSON `json:"-"`
}
// tokenNewResponseEnvelopeJSON contains the JSON metadata for the struct
// [TokenNewResponseEnvelope]
type tokenNewResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenNewResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenNewResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type TokenNewResponseEnvelopeSuccess bool
const (
TokenNewResponseEnvelopeSuccessTrue TokenNewResponseEnvelopeSuccess = true
)
func (r TokenNewResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case TokenNewResponseEnvelopeSuccessTrue:
return true
}
return false
}
type TokenUpdateParams struct {
Token TokenParam `json:"token,required"`
}
func (r TokenUpdateParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r.Token)
}
type TokenUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result TokenUpdateResponseUnion `json:"result,required"`
// Whether the API call was successful
Success TokenUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON tokenUpdateResponseEnvelopeJSON `json:"-"`
}
// tokenUpdateResponseEnvelopeJSON contains the JSON metadata for the struct
// [TokenUpdateResponseEnvelope]
type tokenUpdateResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenUpdateResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type TokenUpdateResponseEnvelopeSuccess bool
const (
TokenUpdateResponseEnvelopeSuccessTrue TokenUpdateResponseEnvelopeSuccess = true
)
func (r TokenUpdateResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case TokenUpdateResponseEnvelopeSuccessTrue:
return true
}
return false
}
type TokenListParams struct {
// Direction to order results.
Direction param.Field[TokenListParamsDirection] `query:"direction"`
// Page number of paginated results.
Page param.Field[float64] `query:"page"`
// Maximum number of results per page.
PerPage param.Field[float64] `query:"per_page"`
}
// URLQuery serializes [TokenListParams]'s query parameters as `url.Values`.
func (r TokenListParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Direction to order results.
type TokenListParamsDirection string
const (
TokenListParamsDirectionAsc TokenListParamsDirection = "asc"
TokenListParamsDirectionDesc TokenListParamsDirection = "desc"
)
func (r TokenListParamsDirection) IsKnown() bool {
switch r {
case TokenListParamsDirectionAsc, TokenListParamsDirectionDesc:
return true
}
return false
}
type TokenDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result TokenDeleteResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success TokenDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON tokenDeleteResponseEnvelopeJSON `json:"-"`
}
// tokenDeleteResponseEnvelopeJSON contains the JSON metadata for the struct
// [TokenDeleteResponseEnvelope]
type tokenDeleteResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenDeleteResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type TokenDeleteResponseEnvelopeSuccess bool
const (
TokenDeleteResponseEnvelopeSuccessTrue TokenDeleteResponseEnvelopeSuccess = true
)
func (r TokenDeleteResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case TokenDeleteResponseEnvelopeSuccessTrue:
return true
}
return false
}
type TokenGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result TokenGetResponseUnion `json:"result,required"`
// Whether the API call was successful
Success TokenGetResponseEnvelopeSuccess `json:"success,required"`
JSON tokenGetResponseEnvelopeJSON `json:"-"`
}
// tokenGetResponseEnvelopeJSON contains the JSON metadata for the struct
// [TokenGetResponseEnvelope]
type tokenGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type TokenGetResponseEnvelopeSuccess bool
const (
TokenGetResponseEnvelopeSuccessTrue TokenGetResponseEnvelopeSuccess = true
)
func (r TokenGetResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case TokenGetResponseEnvelopeSuccessTrue:
return true
}
return false
}
type TokenVerifyResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result TokenVerifyResponse `json:"result,required"`
// Whether the API call was successful
Success TokenVerifyResponseEnvelopeSuccess `json:"success,required"`
JSON tokenVerifyResponseEnvelopeJSON `json:"-"`
}
// tokenVerifyResponseEnvelopeJSON contains the JSON metadata for the struct
// [TokenVerifyResponseEnvelope]
type tokenVerifyResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TokenVerifyResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tokenVerifyResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type TokenVerifyResponseEnvelopeSuccess bool
const (
TokenVerifyResponseEnvelopeSuccessTrue TokenVerifyResponseEnvelopeSuccess = true
)
func (r TokenVerifyResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case TokenVerifyResponseEnvelopeSuccessTrue:
return true
}
return false
}