forked from keycloak/keycloak-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
keycloak.org_keycloakclients_crd.yaml
438 lines (438 loc) · 17.6 KB
/
keycloak.org_keycloakclients_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
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: keycloakclients.keycloak.org
spec:
group: keycloak.org
names:
kind: KeycloakClient
listKind: KeycloakClientList
plural: keycloakclients
singular: keycloakclient
scope: Namespaced
subresources:
status: {}
validation:
openAPIV3Schema:
description: KeycloakClient is the Schema for the keycloakclients 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: KeycloakClientSpec defines the desired state of KeycloakClient.
properties:
client:
description: Keycloak Client REST object.
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
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
realmSelector:
description: Selector for looking up KeycloakRealm 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
roles:
description: Client Roles
items:
description: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_rolerepresentation
properties:
attributes:
additionalProperties:
items:
type: string
type: array
description: Role Attributes
type: object
clientRole:
description: Client Role
type: boolean
composite:
description: Composite
type: boolean
composites:
description: Composites
properties:
client:
additionalProperties:
items:
type: string
type: array
description: Map client => []role
type: object
realm:
description: Realm roles
items:
type: string
type: array
type: object
containerId:
description: Container Id
type: string
description:
description: Description
type: string
id:
description: Id
type: string
name:
description: Name
type: string
required:
- name
type: object
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
scopeMappings:
description: Scope Mappings
properties:
clientMappings:
additionalProperties:
description: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_clientmappingsrepresentation
properties:
client:
description: Client
type: string
id:
description: ID
type: string
mappings:
description: Mappings
items:
description: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_rolerepresentation
properties:
attributes:
additionalProperties:
items:
type: string
type: array
description: Role Attributes
type: object
clientRole:
description: Client Role
type: boolean
composite:
description: Composite
type: boolean
composites:
description: Composites
properties:
client:
additionalProperties:
items:
type: string
type: array
description: Map client => []role
type: object
realm:
description: Realm roles
items:
type: string
type: array
type: object
containerId:
description: Container Id
type: string
description:
description: Description
type: string
id:
description: Id
type: string
name:
description: Name
type: string
required:
- name
type: object
type: array
type: object
description: Client Mappings
type: object
realmMappings:
description: Realm Mappings
items:
description: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_rolerepresentation
properties:
attributes:
additionalProperties:
items:
type: string
type: array
description: Role Attributes
type: object
clientRole:
description: Client Role
type: boolean
composite:
description: Composite
type: boolean
composites:
description: Composites
properties:
client:
additionalProperties:
items:
type: string
type: array
description: Map client => []role
type: object
realm:
description: Realm roles
items:
type: string
type: array
type: object
containerId:
description: Container Id
type: string
description:
description: Description
type: string
id:
description: Id
type: string
name:
description: Name
type: string
required:
- name
type: object
type: array
type: object
required:
- client
- realmSelector
type: object
status:
description: KeycloakClientStatus defines the observed state of KeycloakClient
properties:
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:
type: string
type: array
description: 'A map of all the secondary resources types and names created
for this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2"
]'
type: object
required:
- message
- phase
- ready
type: object
type: object
version: v1alpha1
versions:
- name: v1alpha1
served: true
storage: true