forked from keycloak/keycloak-operator
/
keycloak.org_keycloakrealms_crd.yaml
1018 lines (1018 loc) · 49.1 KB
/
keycloak.org_keycloakrealms_crd.yaml
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
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: keycloakrealms.keycloak.org
spec:
group: keycloak.org
names:
kind: KeycloakRealm
listKind: KeycloakRealmList
plural: keycloakrealms
singular: keycloakrealm
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
description: KeycloakRealm is the Schema for the keycloakrealms API
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: KeycloakRealmSpec defines the desired state of KeycloakRealm.
properties:
instanceSelector:
description: Selector for looking up Keycloak Custom Resources.
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: A label selector requirement is a selector that contains
values, a key, and an operator that relates the key and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: operator represents a key's relationship to a
set of values. Valid operators are In, NotIn, Exists and
DoesNotExist.
type: string
values:
description: values is an array of string values. If the operator
is In or NotIn, the values array must be non-empty. If the
operator is Exists or DoesNotExist, the values array must
be empty. This array is replaced during a strategic merge
patch.
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
description: matchLabels is a map of {key,value} pairs. A single
{key,value} in the matchLabels map is equivalent to an element
of matchExpressions, whose key field is "key", the operator is
"In", and the values array contains only "value". The requirements
are ANDed.
type: object
type: object
realm:
description: Keycloak Realm REST object.
properties:
adminEventsDetailsEnabled:
description: 'Enable admin events details TODO: change to values
and use kubebuilder default annotation once supported'
type: boolean
adminEventsEnabled:
description: 'Enable events recording TODO: change to values and
use kubebuilder default annotation once supported'
type: boolean
authenticationFlows:
description: Authentication flows
items:
properties:
alias:
description: Alias
type: string
authenticationExecutions:
description: Authentication executions
items:
properties:
authenticator:
description: Authenticator
type: string
authenticatorConfig:
description: Authenticator Config
type: string
authenticatorFlow:
description: Authenticator flow
type: boolean
flowAlias:
description: Flow Alias
type: string
priority:
description: Priority
format: int32
type: integer
requirement:
description: Requirement [REQUIRED, OPTIONAL, ALTERNATIVE,
DISABLED]
type: string
userSetupAllowed:
description: User setup allowed
type: boolean
type: object
type: array
builtIn:
description: Built in
type: boolean
description:
description: Description
type: string
id:
description: ID
type: string
providerId:
description: Provider ID
type: string
topLevel:
description: Top level
type: boolean
required:
- alias
- authenticationExecutions
type: object
type: array
authenticatorConfig:
description: Authenticator config
items:
properties:
alias:
description: Alias
type: string
config:
additionalProperties:
type: string
description: Config
type: object
id:
description: ID
type: string
required:
- alias
type: object
type: array
clientScopes:
description: Client scopes
items:
properties:
attributes:
additionalProperties:
type: string
type: object
description:
type: string
id:
type: string
name:
type: string
protocol:
type: string
protocolMappers:
description: Protocol Mappers.
items:
properties:
config:
additionalProperties:
type: string
description: Config options.
type: object
consentRequired:
description: True if Consent Screen is required.
type: boolean
consentText:
description: Text to use for displaying Consent Screen.
type: string
id:
description: Protocol Mapper ID.
type: string
name:
description: Protocol Mapper Name.
type: string
protocol:
description: Protocol to use.
type: string
protocolMapper:
description: Protocol Mapper to use
type: string
type: object
type: array
type: object
type: array
clients:
description: A set of Keycloak Clients.
items:
properties:
access:
additionalProperties:
type: boolean
description: Access options.
type: object
adminUrl:
description: Application Admin URL.
type: string
attributes:
additionalProperties:
type: string
description: Client Attributes.
type: object
authorizationServicesEnabled:
description: True if fine-grained authorization support is
enabled for this client.
type: boolean
authorizationSettings:
description: Authorization settings for this resource server.
properties:
allowRemoteResourceManagement:
description: True if resources should be managed remotely
by the resource server.
type: boolean
clientId:
description: Client ID.
type: string
decisionStrategy:
description: The decision strategy dictates how permissions
are evaluated and how a final decision is obtained.
'Affirmative' means that at least one permission must
evaluate to a positive decision in order to grant access
to a resource and its scopes. 'Unanimous' means that
all permissions must evaluate to a positive decision
in order for the final decision to be also positive.
type: string
id:
description: ID.
type: string
name:
description: Name.
type: string
policies:
description: Policies.
items:
properties:
config:
additionalProperties:
type: string
description: Config.
type: object
decisionStrategy:
description: The decision strategy dictates how
the policies associated with a given permission
are evaluated and how a final decision is obtained.
'Affirmative' means that at least one policy must
evaluate to a positive decision in order for the
final decision to be also positive. 'Unanimous'
means that all policies must evaluate to a positive
decision in order for the final decision to be
also positive. 'Consensus' means that the number
of positive decisions must be greater than the
number of negative decisions. If the number of
positive and negative is the same, the final decision
will be negative.
type: string
description:
description: A description for this policy.
type: string
id:
description: ID.
type: string
logic:
description: The logic dictates how the policy decision
should be made. If 'Positive', the resulting effect
(permit or deny) obtained during the evaluation
of this policy will be used to perform a decision.
If 'Negative', the resulting effect will be negated,
in other words, a permit becomes a deny and vice-versa.
type: string
name:
description: The name of this policy.
type: string
owner:
description: Owner.
type: string
policies:
description: Policies.
items:
type: string
type: array
resources:
description: Resources.
items:
type: string
type: array
resourcesData:
description: Resources Data.
items:
properties:
_id:
description: ID.
type: string
attributes:
additionalProperties:
type: string
description: The attributes associated with
the resource.
type: object
displayName:
description: A unique name for this resource.
The name can be used to uniquely identify
a resource, useful when querying for a specific
resource.
type: string
icon_uri:
description: An URI pointing to an icon.
type: string
name:
description: A unique name for this resource.
The name can be used to uniquely identify
a resource, useful when querying for a specific
resource.
type: string
ownerManagedAccess:
description: True if the access to this resource
can be managed by the resource owner.
type: boolean
scopes:
description: The scopes associated with this
resource.
items: {}
type: array
type:
description: The type of this resource. It
can be used to group different resource
instances with the same type.
type: string
uris:
description: Set of URIs which are protected
by resource.
items:
type: string
type: array
type: object
type: array
scopes:
description: Scopes.
items:
type: string
type: array
scopesData:
description: Scopes Data.
items:
properties:
displayName:
description: A unique name for this scope.
The name can be used to uniquely identify
a scope, useful when querying for a specific
scope.
type: string
iconUri:
description: An URI pointing to an icon.
type: string
id:
description: ID.
type: string
name:
description: A unique name for this scope.
The name can be used to uniquely identify
a scope, useful when querying for a specific
scope.
type: string
policies:
description: Policies.
items: {}
type: array
resources:
description: Resources.
items:
properties:
_id:
description: ID.
type: string
attributes:
additionalProperties:
type: string
description: The attributes associated
with the resource.
type: object
displayName:
description: A unique name for this
resource. The name can be used to
uniquely identify a resource, useful
when querying for a specific resource.
type: string
icon_uri:
description: An URI pointing to an icon.
type: string
name:
description: A unique name for this
resource. The name can be used to
uniquely identify a resource, useful
when querying for a specific resource.
type: string
ownerManagedAccess:
description: True if the access to this
resource can be managed by the resource
owner.
type: boolean
scopes:
description: The scopes associated with
this resource.
items: {}
type: array
type:
description: The type of this resource.
It can be used to group different
resource instances with the same type.
type: string
uris:
description: Set of URIs which are protected
by resource.
items:
type: string
type: array
type: object
type: array
type: object
type: array
type:
description: Type.
type: string
type: object
type: array
policyEnforcementMode:
description: The policy enforcement mode dictates how
policies are enforced when evaluating authorization
requests. 'Enforcing' means requests are denied by default
even when there is no policy associated with a given
resource. 'Permissive' means requests are allowed even
when there is no policy associated with a given resource.
'Disabled' completely disables the evaluation of policies
and allows access to any resource.
type: string
resources:
description: Resources.
items:
properties:
_id:
description: ID.
type: string
attributes:
additionalProperties:
type: string
description: The attributes associated with the
resource.
type: object
displayName:
description: A unique name for this resource. The
name can be used to uniquely identify a resource,
useful when querying for a specific resource.
type: string
icon_uri:
description: An URI pointing to an icon.
type: string
name:
description: A unique name for this resource. The
name can be used to uniquely identify a resource,
useful when querying for a specific resource.
type: string
ownerManagedAccess:
description: True if the access to this resource
can be managed by the resource owner.
type: boolean
scopes:
description: The scopes associated with this resource.
items: {}
type: array
type:
description: The type of this resource. It can be
used to group different resource instances with
the same type.
type: string
uris:
description: Set of URIs which are protected by
resource.
items:
type: string
type: array
type: object
type: array
scopes:
description: Authorization Scopes.
items:
properties:
displayName:
description: A unique name for this scope. The name
can be used to uniquely identify a scope, useful
when querying for a specific scope.
type: string
iconUri:
description: An URI pointing to an icon.
type: string
id:
description: ID.
type: string
name:
description: A unique name for this scope. The name
can be used to uniquely identify a scope, useful
when querying for a specific scope.
type: string
policies:
description: Policies.
items: {}
type: array
resources:
description: Resources.
items:
properties:
_id:
description: ID.
type: string
attributes:
additionalProperties:
type: string
description: The attributes associated with
the resource.
type: object
displayName:
description: A unique name for this resource.
The name can be used to uniquely identify
a resource, useful when querying for a specific
resource.
type: string
icon_uri:
description: An URI pointing to an icon.
type: string
name:
description: A unique name for this resource.
The name can be used to uniquely identify
a resource, useful when querying for a specific
resource.
type: string
ownerManagedAccess:
description: True if the access to this resource
can be managed by the resource owner.
type: boolean
scopes:
description: The scopes associated with this
resource.
items: {}
type: array
type:
description: The type of this resource. It
can be used to group different resource
instances with the same type.
type: string
uris:
description: Set of URIs which are protected
by resource.
items:
type: string
type: array
type: object
type: array
type: object
type: array
type: object
baseUrl:
description: Application base URL.
type: string
bearerOnly:
description: True if a client supports only Bearer Tokens.
type: boolean
clientAuthenticatorType:
description: What Client authentication type to use.
type: string
clientId:
description: Client ID.
type: string
consentRequired:
description: True if Consent Screen is required.
type: boolean
defaultClientScopes:
description: A list of default client scopes. Default client
scopes are always applied when issuing OpenID Connect tokens
or SAML assertions for this client.
items:
type: string
type: array
defaultRoles:
description: Default Client roles.
items:
type: string
type: array
description:
description: Client description.
type: string
directAccessGrantsEnabled:
description: True if Direct Grant is enabled.
type: boolean
enabled:
description: Client enabled flag.
type: boolean
frontchannelLogout:
description: True if this client supports Front Channel logout.
type: boolean
fullScopeAllowed:
description: True if Full Scope is allowed.
type: boolean
id:
description: Client ID. If not specified, automatically generated.
type: string
implicitFlowEnabled:
description: True if Implicit flow is enabled.
type: boolean
name:
description: Client name.
type: string
nodeReRegistrationTimeout:
description: Node registration timeout.
type: integer
notBefore:
description: Not Before setting.
type: integer
optionalClientScopes:
description: A list of optional client scopes. Optional client
scopes are applied when issuing tokens for this client,
but only when they are requested by the scope parameter
in the OpenID Connect authorization request.
items:
type: string
type: array
protocol:
description: Protocol used for this Client.
type: string
protocolMappers:
description: Protocol Mappers.
items:
properties:
config:
additionalProperties:
type: string
description: Config options.
type: object
consentRequired:
description: True if Consent Screen is required.
type: boolean
consentText:
description: Text to use for displaying Consent Screen.
type: string
id:
description: Protocol Mapper ID.
type: string
name:
description: Protocol Mapper Name.
type: string
protocol:
description: Protocol to use.
type: string
protocolMapper:
description: Protocol Mapper to use
type: string
type: object
type: array
publicClient:
description: True if this is a public Client.
type: boolean
redirectUris:
description: A list of valid Redirection URLs.
items:
type: string
type: array
rootUrl:
description: Application root URL.
type: string
secret:
description: Client Secret. The Operator will automatically
create a Secret based on this value.
type: string
serviceAccountsEnabled:
description: True if Service Accounts are enabled.
type: boolean
standardFlowEnabled:
description: True if Standard flow is enabled.
type: boolean
surrogateAuthRequired:
description: Surrogate Authentication Required option.
type: boolean
useTemplateConfig:
description: True to use a Template Config.
type: boolean
useTemplateMappers:
description: True to use Template Mappers.
type: boolean
useTemplateScope:
description: True to use Template Scope.
type: boolean
webOrigins:
description: A list of valid Web Origins.
items:
type: string
type: array
required:
- clientId
type: object
type: array
displayName:
description: Realm display name.
type: string
duplicateEmailsAllowed:
description: Duplicate emails
type: boolean
editUsernameAllowed:
description: Edit username
type: boolean
enabled:
description: Realm enabled flag.
type: boolean
eventsEnabled:
description: 'Enable events recording TODO: change to values and
use kubebuilder default annotation once supported'
type: boolean
eventsListeners:
description: A set of Event Listeners.
items:
type: string
type: array
id:
type: string
identityProviders:
description: A set of Identity Providers.
items:
properties:
addReadTokenRoleOnCreate:
description: Adds Read Token role when creating this Identity
Provider.
type: boolean
alias:
description: Identity Provider Alias.
type: string
config:
additionalProperties:
type: string
description: Identity Provider config.
type: object
displayName:
description: Identity Provider Display Name.
type: string
enabled:
description: Identity Provider enabled flag.
type: boolean
firstBrokerLoginFlowAlias:
description: Identity Provider First Broker Login Flow Alias.
type: string
internalId:
description: Identity Provider Internal ID.
type: string
linkOnly:
description: Identity Provider Link Only setting.
type: boolean
postBrokerLoginFlowAlias:
description: Identity Provider Post Broker Login Flow Alias.
type: string
providerId:
description: Identity Provider ID.
type: string
storeToken:
description: Identity Provider Store to Token.
type: boolean
trustEmail:
description: Identity Provider Trust Email.
type: boolean
type: object
type: array
loginWithEmailAllowed:
description: Login with email
type: boolean
realm:
description: Realm name.
type: string
registrationAllowed:
description: User registration
type: boolean
registrationEmailAsUsername:
description: Email as username
type: boolean
rememberMe:
description: Remember me
type: boolean
resetPasswordAllowed:
description: Forgot password
type: boolean
sslRequired:
description: Require SSL
type: string
userFederationMappers:
description: User federation mappers are extension points triggered
by the user federation at various points.
items:
description: https://www.keycloak.org/docs/11.0/server_admin/#_ldap_mappers
https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_userfederationmapperrepresentation
properties:
config:
additionalProperties:
type: string
description: User federation mapper config.
type: object
federationMapperType:
type: string
federationProviderDisplayName:
description: The displayName for the user federation provider
this mapper applies to.
type: string
id:
type: string
name:
type: string
type: object
type: array
userFederationProviders:
description: Point keycloak to an external user provider to validate
credentials or pull in identity information.
items:
description: https://www.keycloak.org/docs-api/10.0/rest-api/index.html#_userfederationproviderrepresentation
properties:
config:
additionalProperties:
type: string
description: User federation provider config.
type: object
displayName:
description: The display name of this provider instance.
type: string
fullSyncPeriod:
format: int32
type: integer
id:
description: The ID of this provider
type: string
priority:
description: The priority of this provider when looking up
users or adding a user.
format: int32
type: integer
providerName:
description: The name of the user provider, such as "ldap",
"kerberos" or a custom SPI.
type: string
type: object
type: array
users:
description: A set of Keycloak Users.
items:
properties:
attributes:
additionalProperties:
items:
type: string
type: array
description: A set of Attributes.
type: object
clientRoles:
additionalProperties:
items:
type: string
type: array
description: A set of Client Roles.
type: object
credentials:
description: A set of Credentials.
items:
properties:
temporary:
description: True if this credential object is temporary.
type: boolean
type:
description: Credential Type.
type: string
value:
description: Credential Value.
type: string
type: object
type: array
email:
description: Email.
type: string
emailVerified:
description: True if email has already been verified.
type: boolean
enabled:
description: User enabled flag.
type: boolean
federatedIdentities:
description: A set of Federated Identities.
items:
properties:
identityProvider:
description: Federated Identity Provider.
type: string
userId:
description: Federated Identity User ID.
type: string
userName:
description: Federated Identity User Name.
type: string
type: object
type: array
firstName:
description: First Name.
type: string
groups:
description: A set of Groups.
items:
type: string
type: array
id:
description: User ID.
type: string
lastName:
description: Last Name.
type: string
realmRoles:
description: A set of Realm Roles.
items:
type: string
type: array
requiredActions:
description: A set of Required Actions.
items:
type: string
type: array
username:
description: User Name.
type: string
type: object
type: array
verifyEmail:
description: Verify email
type: boolean
required:
- realm
type: object
realmOverrides:
description: A list of overrides to the default Realm behavior.
items:
properties:
forFlow:
description: Flow to be overridden.
type: string
identityProvider:
description: Identity Provider to be overridden.
type: string
required:
- identityProvider
type: object
type: array
x-kubernetes-list-type: atomic
unmanaged:
description: When set to true, this KeycloakRealm will be marked as
unmanaged and not be managed by this operator. It can then be used
for targeting purposes.
type: boolean
required:
- realm
type: object
status:
description: KeycloakRealmStatus defines the observed state of KeycloakRealm
properties:
loginURL:
description: TODO
type: string
message:
description: Human-readable message indicating details about current
operator phase or error.
type: string
phase:
description: Current phase of the operator.
type: string
ready:
description: True if all resources are in a ready state and all work
is done.
type: boolean
secondaryResources:
additionalProperties:
items: