-
Notifications
You must be signed in to change notification settings - Fork 4
/
public.openapi.yaml
1196 lines (1196 loc) · 46.2 KB
/
public.openapi.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
---
openapi: 3.0.2
info:
title: idmsvc-backend
description: Backend API for Directory & Domain Services
contact: {}
version: 1.0.0
servers:
- description: Production
url: /api/idmsvc/v1
- description: Beta
url: /beta/api/idmsvc/v1
- description: Preview
url: /preview/api/idmsvc/v1
paths:
/domains:
description: It store the necessary information about a domain that will let manage them
summary: Domain resource
parameters:
- $ref: '#/components/parameters/XRhInsightsRequestIdHeader'
get:
description: |-
For the current organization, list all the domains that
are being managed from console.dot
summary: List domains in the organization
parameters:
- name: offset
description: pagination offset
required: false
schema:
type: integer
examples:
Default offset:
value: 0
Page 2 for pages of 10 items:
value: 10
in: query
- name: limit
description: Number of items per page
required: false
schema:
type: integer
examples:
15 items per page:
value: 15
Default value:
value: 10
in: query
operationId: listDomains
responses:
'200':
$ref: '#/components/responses/ListDomainsResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:User
- Type:ServiceAccount
tags:
- resources
post:
description: Register a domain in the current organization.
summary: Register a domain.
parameters:
- $ref: '#/components/parameters/XRhIdmRegistrationTokenHeader'
- $ref: '#/components/parameters/XRhIdmVersionHeader'
operationId: RegisterDomain
requestBody:
description: Domain object to be registered.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterDomainRequest'
responses:
'201':
$ref: '#/components/responses/RegisterDomainResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:System
- x-rh-idm-registration-token: []
tags:
- resources
/domains/token:
description: Request a domain registration token
summary: Domain registration token
parameters:
- $ref: '#/components/parameters/XRhInsightsRequestIdHeader'
post:
description: Request a domain registration token
summary: Domain registration token request
operationId: createDomainToken
requestBody:
description: Domain registration request
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DomainRegTokenRequest'
responses:
'201':
$ref: '#/components/responses/DomainRegTokenResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:User
- Type:ServiceAccount
tags:
- resources
/domains/{uuid}:
description: Specific operations on an existing domain to read, update or delete it.
summary: Operations on a specific domain
parameters:
- $ref: '#/components/parameters/XRhInsightsRequestIdHeader'
- $ref: '#/components/parameters/DomainIdParam'
delete:
description: Delete an existing domain from the current organization.
summary: Delete domain.
operationId: deleteDomain
responses:
'204':
description: Returned when the resource was deleted.
'400':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:User
- Type:ServiceAccount
tags:
- resources
get:
description: Request the information for a specific domain of our organization.
summary: Read a domain.
operationId: readDomain
responses:
'200':
$ref: '#/components/responses/ReadDomainResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:User
- Type:ServiceAccount
tags:
- resources
patch:
description: Update the rhel-idm domain information.
summary: Update domain information by user.
operationId: updateDomainUser
requestBody:
description: Information for an IPA domain so it is updated from the ipa-hcc agent.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDomainUserRequest'
responses:
'200':
$ref: '#/components/responses/UpdateDomainUserResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:User
- Type:ServiceAccount
tags:
- resources
put:
description: Update the rhel-idm domain information.
summary: Update domain information by ipa-hcc agent.
parameters:
- $ref: '#/components/parameters/XRhIdmVersionHeader'
operationId: updateDomainAgent
requestBody:
description: Information for an IPA domain so it is updated from the ipa-hcc agent.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDomainAgentRequest'
responses:
'200':
$ref: '#/components/responses/UpdateDomainAgentResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'403':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:System:domain
tags:
- actions
/host-conf/{inventory_id}/{fqdn}:
description: Endpoint used by host vm for auto-enrollment.
summary: Autoenroll host vm endpoint.
parameters:
- $ref: '#/components/parameters/XRhInsightsRequestIdHeader'
- name: inventory_id
description: A Host-Based Inventory ID of the host.
required: true
schema:
$ref: '#/components/schemas/HostId'
in: path
- name: fqdn
description: The full qualified domain name of the host.
required: true
schema:
$ref: '#/components/schemas/Fqdn'
in: path
post:
description: Action to retrieve the host information for the host vm being enrolled.
summary: Get host vm information.
operationId: hostConf
requestBody:
description: Required information to take the action.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HostConf'
examples:
demo request:
value:
fqdn: host1.domain.example
subscription_manager_id: c3ac4b91-27cc-422c-a283-42aadfe730af
responses:
'200':
$ref: '#/components/responses/HostConfResponse'
'404':
description: No enabled domains matched request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'409':
description: Multiple active domains matched request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:System:domain
tags:
- actions
/signing_keys:
description: Signing keys and revokation information for host conf JWKs
summary: Signing keys
parameters:
- $ref: '#/components/parameters/XRhInsightsRequestIdHeader'
get:
description: |-
Get signing keys and revokation information
summary: Signing keys
operationId: getSigningKeys
responses:
'200':
$ref: '#/components/responses/ReadKeysResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'413':
$ref: '#/components/responses/ErrorResponse'
'431':
$ref: '#/components/responses/ErrorResponse'
security:
- x-rh-identity:
- Type:System
- Type:User
- Type:ServiceAccount
tags:
- resources
components:
parameters:
DomainIdParam:
name: uuid
description: The uuid that identify the domain.
required: true
schema:
$ref: '#/components/schemas/DomainId'
examples:
a random uuid generated by 'uuid' command:
value: '"2e8ce5a6-b370-11ed-9330-482ae3863d30"'
in: path
XRhIdmRegistrationTokenHeader:
name: X-Rh-Idm-Registration-Token
description: One-time password to authenticate domain registration with ipa-hcc command.
required: true
schema:
type: string
in: header
XRhIdmVersionHeader:
name: X-Rh-Idm-Version
description: ipa-hcc agent version
required: true
schema:
type: string
in: header
XRhInsightsRequestIdHeader:
name: X-Rh-Insights-Request-Id
description: Request id for distributed tracing.
required: false
schema:
type: string
in: header
responses:
DomainRegTokenResponse:
description: Response with domain registration token
content:
application/json:
schema:
$ref: '#/components/schemas/DomainRegToken'
ErrorResponse:
description: Error response for some operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
HostConfResponse:
description: Response for the HostConf action.
content:
application/json:
schema:
$ref: '#/components/schemas/HostConfResponseSchema'
ListDomainsResponse:
description: It represent the response for a list of domains query.
content:
application/json:
schema:
$ref: '#/components/schemas/ListDomainsResponseSchema'
ReadDomainResponse:
description: This represent the response for a specific domain.
content:
application/json:
schema:
$ref: '#/components/schemas/DomainResponse'
ReadKeysResponse:
description: Response for get keys operation by system or user.
content:
application/json:
schema:
$ref: '#/components/schemas/SigningKeysResponse'
RegisterDomainResponse:
description: Response for the domain register operation.
content:
application/json:
schema:
$ref: '#/components/schemas/DomainRegisterResponse'
UpdateDomainAgentResponse:
description: Response for the domain update operation by ipa-hcc agent.
content:
application/json:
schema:
$ref: '#/components/schemas/DomainUpdateResponse'
UpdateDomainUserResponse:
description: Response for the domain update operation by user.
content:
application/json:
schema:
$ref: '#/components/schemas/DomainResponse'
schemas:
CaCertBundle:
title: A bundle of CA certificates
description: A string of concatenated, PEM-encoded X.509 certificates
type: string
x-rh-ipa-hcc:
type: defs
Certificate:
type: object
required:
- issuer
- nickname
- not_after
- not_before
- pem
- serial_number
- subject
additionalProperties: false
properties:
issuer:
title: Issuer name (RFC 4514 string)
type: string
format: cert-issuer
example: O=DOMAIN.EXAMPLE, CN=Certificate Authority
nickname:
title: Internal nick name in LDAP (RDN cn)
type: string
example: DOMAIN.EXAMPLE CA
not_after:
title: Not valid after timestamp (UTC)
type: string
format: date-time
example: '2043-03-21T05:38:09+00:00'
not_before:
title: Not valid before timestamp (UTC)
type: string
format: date-time
example: '2023-03-21T05:38:09+00:00'
pem:
title: PEM encoded X.509 certificate
type: string
format: cert-pem
example: '-----BEGIN CERTIFICATE-----\nMII...\n-----END CERTIFICATE-----\n'
serial_number:
title: Serial number (base 10)
type: string
pattern: ^[1-9][0-9]*$
example: '1'
subject:
title: Subject name (RFC 4514 string)
type: string
format: cert-subject
example: O=DOMAIN.EXAMPLE, CN=Certificate Authority
x-rh-ipa-hcc:
type: defs
x-rh-rdn-value: nickname
Domain:
title: Base type for domain objects
description: A domain resource
type: object
required:
- domain_name
- domain_type
additionalProperties: false
properties:
title:
description: Title to describe the domain.
type: string
format: domain-title
description:
description: Human readable description abou the domain.
type: string
format: domain-description
auto_enrollment_enabled:
description: Enable or disable host vm auto-enrollment for this domain
type: boolean
example: 'true'
domain_id:
$ref: '#/components/schemas/DomainId'
domain_name:
$ref: '#/components/schemas/DomainName'
domain_type:
$ref: '#/components/schemas/DomainType'
rhel-idm:
$ref: '#/components/schemas/DomainIpa'
x-rh-ipa-hcc:
type: defs
x-rh-rdn-value: domain_name
example:
description: My awesome domain description.
auto_enrollment_enabled: true
domain_id: 1aa15eae-a88b-11ed-a2cb-482ae3863d30
domain_name: mydomain.example
domain_type: rhel-idm
rhel-idm:
servers:
- fqdn: server1.mydomain.example
- fqdn: server2.mydomain.example
ca_certs: []
realm_name: IPA.EXAMPLE
DomainId:
title: domain id
description: A domain id
type: string
format: uuid
maxLength: 36
minLength: 36
x-rh-ipa-hcc:
type: defs
example: 772e9618-d0f8-4bf8-bfed-d2831f63c619
DomainIpa:
title: Root Type for ResponseIpaObject
description: Options for ipa domains
type: object
required:
- ca_certs
- locations
- realm_domains
- realm_name
- servers
additionalProperties: false
properties:
servers:
description: List of auto-enrollment enabled servers for this domain.
type: array
items:
$ref: '#/components/schemas/DomainIpaServer'
automount_locations:
description: List of automount locations for AutoFS
type: array
items:
type: string
minLength: 1
minItems: 0
example: '["default"]'
ca_certs:
description: A base64 representation of all the list of chain of certificates, including the server ca.
type: array
items:
$ref: '#/components/schemas/Certificate'
example: >-
[
{
"nickname": "MYDOMAIN.EXAMPLE IPA CA",
"issuer": "CN=Certificate Authority,O=MYDOMAIN.EXAMPLE",
"subject": "CN=Certificate Authority,O=MYDOMAIN.EXAMPLE",
"serial_number": "1",
"not_before": "2023-01-31T13:23:36Z",
"not_after": "2023-01-31T13:23:36Z"
"pem": "-----BEGIN CERTIFICATE-----\nMIIE...\n-----END CERTIFICATE-----\n",
}
]
locations:
description: List of DNS locations
type: array
items:
$ref: '#/components/schemas/Location'
minItems: 0
example: >-
[{"name":"boston","description":"Boston data center"}]
realm_domains:
description: List of realm associated to the IPA domain.
type: array
items:
$ref: '#/components/schemas/DomainName'
format: ipa-realm-domains
minItems: 1
realm_name:
$ref: '#/components/schemas/RealmName'
x-rh-ipa-hcc:
name: RhelIdmDomain
type: defs
DomainIpaServer:
title: Root Type for CreateDomainIpaServer
description: Server schema for an entry into the Ipa domain type.
type: object
required:
- ca_server
- fqdn
- hcc_enrollment_server
- hcc_update_server
- pkinit_server
additionalProperties: false
properties:
ca_server:
type: boolean
example: 'true'
fqdn:
$ref: '#/components/schemas/Fqdn'
hcc_enrollment_server:
type: boolean
example: 'true'
hcc_update_server:
type: boolean
example: 'true'
location:
$ref: '#/components/schemas/LocationName'
pkinit_server:
type: boolean
example: 'true'
subscription_manager_id:
$ref: '#/components/schemas/SubscriptionManagerId'
x-rh-ipa-hcc:
name: IPAServer
type: defs
x-rh-rdn-value: fqdn
example:
ca_server: true
fqdn: ipaserver.mydomain.example
hcc_enrollment_server: true
hcc_update_server: true
location: europe
pkinit_server: true
subscription_manager_id: 03965a2c-bd24-11ed-968d-482ae3863d30
DomainName:
title: Fully qualified domain name
description: >
A name of a domain (all lower-case). The domain name can only
be set during initial registration and not be modified by
updates.
type: string
format: idn-hostname
maxLength: 253
minLength: 3
x-rh-ipa-hcc:
type: defs
example: domain.example
DomainRegToken:
title: Root Type for domain registration token response
description: A domain registration response
type: object
required:
- domain_id
- domain_token
- domain_type
- expiration
additionalProperties: false
properties:
domain_id:
$ref: '#/components/schemas/DomainId'
domain_token:
description: A domain registration token string
type: string
domain_type:
$ref: '#/components/schemas/DomainType'
expiration:
description: Expiration time stamp (Unix timestamp)
type: integer
x-rh-ipa-hcc:
name: DomainRegTokenResponse
type: response
example:
domain_id: 681abfd7-18ce-51b3-a9cc-10d386c8dc35
domain_token: F3kVxQP4sIs.cjbtH-GB8JuszfqrQnnudLoLzJH3zkw5jnhmTgKP_HU
domain_type: rhel-idm
expiration: 1691407070
DomainRegTokenRequest:
title: Root Type for domain registration token request
description: A domain registration request
type: object
required:
- domain_type
additionalProperties: false
properties:
domain_type:
$ref: '#/components/schemas/DomainType'
x-rh-ipa-hcc:
name: DomainRegTokenRequest
type: request
example:
domain_type: rhel-idm
DomainRegisterResponse:
title: Response type for domain registration
description: TODO
type: object
required:
- domain_id
allOf:
- $ref: '#/components/schemas/Domain'
x-rh-ipa-hcc:
name: IPADomainRegisterResponse
type: response
DomainResponse:
title: Root Type for DomainResponse
description: A domain resource
required:
- auto_enrollment_enabled
- domain_id
allOf:
- $ref: '#/components/schemas/Domain'
x-rh-ipa-hcc:
name: IPADomainGetResponse
type: response
DomainType:
title: Domain Type
description: Type of domain (currently only rhel-idm)
type: string
enum:
- rhel-idm
x-rh-ipa-hcc:
type: defs
example: rhel-idm
DomainUpdateResponse:
title: Response type for domain update
description: TODO
type: object
required:
- auto_enrollment_enabled
allOf:
- $ref: '#/components/schemas/Domain'
x-rh-ipa-hcc:
name: IPADomainUpdateResponse
type: response
ErrorInfo:
title: Error information
type: object
required:
- id
- status
- title
additionalProperties: false
properties:
title:
title: HTTP status text
description: The human-readable HTTP status text for the error.
type: string
example: Not Found
code:
description: an application-specific error code
type: string
detail:
title: Detail
description: A detailed explanation of the error, e.g. traceback.
type: string
example: Resource not found
id:
title: Error identifier
description: a unique identifier for this particular occurrence of the problem.
type: string
example: 27c19744-29f2-42a0-8669-8fa050f8ffdf
status:
title: HTTP status code
description: The HTTP status code for the error.
type: string
format: http-status
maxLength: 3
minLength: 3
pattern: ^[1-5][0-9][0-9]$
example: '404'
x-rh-ipa-hcc:
type: defs
Errors:
title: Root Type for ErrorResponse
description: General error response returned by the idmsvc API
type: object
required:
- errors
additionalProperties: false
properties:
errors:
description: Error objects provide additional information about problems encountered while performing an operation.
type: array
items:
$ref: '#/components/schemas/ErrorInfo'
minItems: 1
readOnly: true
example: >
[
{
"id": "${X-RH-INSIGHTS-REQUEST-ID}",
"status": "400",
"title": "Bad Request",
"detail": "additional details: more additional details"
}
]
x-rh-ipa-hcc:
type: response
example:
errors:
- detail: 'Bad request: additional details: more additional details'
id: ${X-RH-INSIGHTS-REQUEST-ID}
status: '400'
Fqdn:
title: FQDN
description: A host's Fully Qualified Domain Name (all lower-case).
type: string
format: idn-hostname
maxLength: 253
minLength: 3
x-rh-ipa-hcc:
type: defs
example: host.domain.example
HostConf:
title: Root Type for HostConf
description: Represent the request payload for the /host-conf/:inventory_id/:fqdn endpoint.
type: object
additionalProperties: false
properties:
domain_id:
$ref: '#/components/schemas/DomainId'
domain_name:
$ref: '#/components/schemas/DomainName'
domain_type:
$ref: '#/components/schemas/DomainType'
x-rh-ipa-hcc:
name: HostConfRequest
type: request
example:
fqdn: host1.domain.example
subscription_manager_id: c3ac4b91-27cc-422c-a283-42aadfe730af
HostConfIpa:
title: Root Type for ResponseIpaObject
description: Options for ipa domains
type: object
required:
- cabundle
- enrollment_servers
- realm_name
additionalProperties: false
properties:
automount_location:
description: Automount location name for ipa-client-automount
type: string
minLength: 1
example: default
cabundle:
$ref: '#/components/schemas/CaCertBundle'
enrollment_servers:
description: List of auto-enrollment enabled servers for this domain.
type: array
items:
$ref: '#/components/schemas/HostConfIpaServer'
example: '[{"fqdn": "server1.mydomain.example"}, {"fqdn": "server2.mydomain.example"}]'
ipa_client_install_args:
description: List of additional arguments for ipa-client-install
type: array
items:
type: string
example: '["--enable-dns-updates"]'
realm_name:
$ref: '#/components/schemas/RealmName'
x-rh-ipa-hcc:
type: defs
example:
cabundle: base64
realm_name: IPA.EXAMPLE
server_list:
- fqdn: server1.mydomain.example
- fqdn: server2.mydomain.example
HostConfIpaServer:
description: Auto-enrollment enabled server for this domain.
type: object
required:
- fqdn
additionalProperties: false
properties:
fqdn:
$ref: '#/components/schemas/Fqdn'
location:
$ref: '#/components/schemas/LocationName'
x-rh-ipa-hcc:
type: defs
example: '{"fqdn": "server1.mydomain.example"}'
HostConfResponseSchema:
title: Root Type for HostConfResponse
description: >-
The response for the action to retrieve the host vm information when it is being enrolled. This action is taken from the host vm.
type: object
required:
- auto_enrollment_enabled
- domain_id
- domain_name
- domain_type
- rhel-idm
additionalProperties: false
properties:
auto_enrollment_enabled:
description: Enable or disable host vm auto-enrollment for this domain
type: boolean
example: 'true'
domain_id:
$ref: '#/components/schemas/DomainId'
domain_name:
$ref: '#/components/schemas/DomainName'
domain_type:
$ref: '#/components/schemas/DomainType'
rhel-idm:
$ref: '#/components/schemas/HostConfIpa'
token:
$ref: '#/components/schemas/HostToken'
x-rh-ipa-hcc:
name: HostConfResponse
type: response
example:
domain_name: domain.example
domain_type: rhel-idm
rhel-idm:
ca_cert: |
-----BEGIN CERTIFICATE-----
MII...
-----END CERTIFICATE-----
realm_name: DOMAIN.EXAMPLE
server_list:
- ipaserver.domain.example
HostId:
title: host id
description: A Host-Based Inventory ID of a host.
type: string
format: uuid
maxLength: 36
minLength: 36
x-rh-ipa-hcc:
type: defs
example: f0468001-7632-4d3f-afd2-770c93825adf
HostToken:
title: Host Token
description: A serialized JWS token or JWT to authenticate a host registration request.
type: string
x-rh-ipa-hcc:
type: defs
ListDomainsData:
title: Root Type for ListDomainsData
description: The data listed for the domains.
type: object
required:
- auto_enrollment_enabled
- description
- domain_id
- domain_name
- domain_type
- title
additionalProperties: false
properties:
title:
description: Human-friendly title for the domain entry.
type: string
description:
description: Human-readable description of the domain entry.
type: string
auto_enrollment_enabled:
type: boolean
domain_id:
$ref: '#/components/schemas/DomainId'
domain_name:
$ref: '#/components/schemas/DomainName'
domain_type:
$ref: '#/components/schemas/DomainType'
example:
auto_enrollment_enabled: true
domain_id: 1aa15eae-a88b-11ed-a2cb-482ae3863d30
domain_name: mydomain.example
domain_type: rhel-idm
ListDomainsResponseSchema:
title: Root Type for ListDomains
description: Represent a paginated result for a list of domains
type: object
required:
- data
- links
- meta
additionalProperties: false
properties:
data:
description: The content for this page.
type: array
items:
$ref: '#/components/schemas/ListDomainsData'
links:
$ref: '#/components/schemas/PaginationLinks'
meta:
$ref: '#/components/schemas/PaginationMeta'
example:
data:
- auto_enrollment_enabled: true
domain_id: 1aa15eae-a88b-11ed-a2cb-482ae3863d30
domain_name: mydomain.example
domain_type: rhel-idm
links:
first: /api/idm/v1/domains?limit=10&offset=0
last: /api/idm/v1/domains?limit=10&offset=10
next: /api/idm/v1/domains?limit=10&offset=10
previous: /api/idm/v1/domains?limit=10&offset=0
meta:
count: 1
Location:
title: Location record
description: RHEL IdM server location
type: object