forked from iot-onboarding/scim-devices
-
Notifications
You must be signed in to change notification settings - Fork 0
/
scim.yml
1021 lines (1018 loc) · 42.1 KB
/
scim.yml
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.3
info:
title: Onboarding API
description: Onboarding APIs using the SCIM interface
version: 1.0.0
servers:
- url: https://{gw_host}/scim/v2
variables:
gw_host:
default: localhost
description: Gateway Host
security:
- ApiKeyAuth: []
paths:
/Users:
post:
tags:
- SCIM
summary: Create Device
requestBody:
content:
application/scim+json:
schema:
oneOf:
- $ref: "#/components/schemas/BLEDevice"
- $ref: "#/components/schemas/ZigbeeDevice"
- $ref: "#/components/schemas/WifiDevice"
responses:
"201":
description: Successful response
content:
application/scim+json:
schema:
oneOf:
- $ref: "#/components/schemas/BLEDevice"
- $ref: "#/components/schemas/ZigbeeDevice"
- $ref: "#/components/schemas/WifiDevice"
/Users/{uuid}:
get:
tags:
- SCIM
summary: Get Device
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/scim+json
- name: uuid
in: path
schema:
type: string
required: true
responses:
"404":
description: Specified device does not exist
"200":
description: Successful response
content:
application/scim+json:
schema:
oneOf:
- $ref: "#/components/schemas/BLEDevice"
- $ref: "#/components/schemas/ZigbeeDevice"
- $ref: "#/components/schemas/WifiDevice"
put:
tags:
- SCIM
summary: Update Device
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/scim+json
- name: uuid
in: path
schema:
type: string
required: true
responses:
"404":
description: Specified device does not exist
"200":
description: Successful response
content:
application/scim+json:
schema:
oneOf:
- $ref: "#/components/schemas/BLEDevice"
- $ref: "#/components/schemas/ZigbeeDevice"
- $ref: "#/components/schemas/WifiDevice"
delete:
tags:
- SCIM
summary: Delete Device
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/scim+json
- name: uuid
in: path
schema:
type: string
required: true
responses:
"204":
description: Successful response
/Bulk:
post:
tags:
- SCIM
summary: Bulk
requestBody:
content:
application/scim+json:
schema:
$ref: "#/components/schemas/BulkRequest"
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/scim+json
responses:
"200":
description: Successful response
content:
application/scim+json: {}
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
schemas:
Device:
type: object
title: SCIM device core schema
required:
- schemas
- id
properties:
schemas:
type: array
description:
This is a default attribute of SCIM which
contains the list of schema URIs that are present in the
SCIM JSON object. It contains URI of core schema and
extension schema. It may also include URI for applications
schema depending on use-case.
example: urn:ietf:params:scim:schemas:core:2.0:Device
items: {}
x-item:
type: string
id:
type: string
title: ID
uniqueItems: true
description:
It represents a unique device ID, formated as
128 bit UUID format. It provides a uniform way of uniquely
identifying the device in the scope of the application.
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
example: e9e30dba-f08f-4109-8486-d5c6a3312345
displayName:
type: string
title: Display Name
description:
Human readable name of the device, suitable for
displaying to end-users.
example: BLE Heart Monitor
adminState:
type: boolean
title: Admin State
default: false
description:
A mutable boolean value indicating the device
administrative status. An admin can set this flag. If set
TRUE, the commands (such as connect, disconnect,
subscribe) that control app sends to the controller for
the devices will be processeed by the controller. If set
FALSE, any command coming from the control app for the
device will be rejected by the controller.
connectivity:
type: array
items:
type: string
title: Connectivity
description:
It represents the communication technology
supported by the device such as BLE, WiFi, LoRa.
example: BLE
mudUrl:
type: string
format: iri-reference
title: MUD URL
description: A URL to MUD file of the device (RFC 8520).
meta:
type: object
title: MetaData
required:
- resourceType
- created
- lastModified
- version
- location
properties:
resourceType:
type: string
title: Resource type
enum:
- Device
description:
The name of the resource type of the
resource. This attribute has a mutability of readOnly.
readOnly: true
created:
type: string
format: dateTime
title: Created
description:
The DateTime that the resource was added to
the service provider. This attribute MUST be a DateTime.
lastModified:
type: string
format: dateTime
title: Last modified
description:
The most recent DateTime that the details
of this resource were updated at the service
provider. If this resource has never been modified
since its initial creation, the value MUST be the same
as the value of created.
version:
type: string
title: Version
description:
The version of the resource being
returned. This value must be the same as the
entity-tag (ETag) HTTP response header (see Sections
2.1 and 2.3 of [RFC7232]).
location:
type: string
format: iri-reference
title: Location
description:
The URI of the resource being
returned. This value MUST be the same as the
Content-Location HTTP response header (see Section
3.1.4.2 of [RFC7231]).
BLEDevice:
title: SCIM device BLE schema
allOf:
- $ref: "#/components/schemas/Device"
- type: object
required:
- adminState
- connectivity
- meta
properties:
urn:ietf:params:scim:schemas:extension:Ble:2.0:Device:
type: object
title: Device extension schema for BLE
required:
- versionSupport
- deviceMacAddress
- addressType
- pairingMethods
properties:
versionSupport:
type: array
items:
type: string
title: Version support
description:
Provides a list of all the BLE versions supported
by the device.
example: "4.1"
deviceMacAddress:
type: string
title: Device MAC address
description:
It is the public MAC address assigned
by the manufacturer. It is unique 48 bit value.
pattern: ^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$
example: 01:23:45:67:89:AB
addressType:
type: boolean
title: Address type
default: false
description:
AddressType flag is taken from the BLE core
specifications 5.3. If FALSE, the device is using
public MAC address. If TRUE, device is using Random
address which is resolved using IRK.
irk:
type: string
title: Identity resolving key
description: Identity resolving key, which is unique
for every device. It is used to resolve random
address.
pairingMethods:
type: array
title: Pairing methods
example: urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device
items: {}
x-item:
type: string
urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device:
title: Extension for null pairing method
description: This pairing method is for the BLE
devices that do not use any pairing method and
connects with the nearest device when powered
up. There is no attribute for this method.
nullable: true
? urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0:Device
: type: object
title: Extension for just works pairing method.
properties:
key:
title: Key
description: Just works does not have any key
value. For completeness, it is added with a key value
'null'.
nullable: true
? urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0:Device
: type: object
title: Extension for pass key pairing method.
properties:
key:
type: integer
title: Key
description: A six digit passkey for ble device
pattern: ^[0-9]{6}$
urn:ietf:params:scim:schemas:extension:pairingOOB:2.0:Device:
type: object
title: Extension for out of band pairing method.
required:
- key
- randNumber
properties:
key:
type: string
title: Key
description:
A key value retrieved from out of band source
such as NFC.
randNumber:
type: integer
title: Random number
description: Nonce added to the key.
confirmationNumber:
type: integer
title: Confirmation number
description:
Some solutions require confirmation number
RESTful message exchange.
urn:ietf:params:scim:schemas:extension:Endpoints:2.0:Device:
type: object
title: Endpoints extension schema for partner application
description:
Endpoint schema contains URLs and root
certificates for the partner application and URLs for
enterprise endpoints.
required:
- onboarding
- deviceControl
- dataReceiver
properties:
onboarding:
type: object
title: Onboarding
description: Onboarding application attributes.
required:
- onboardingAppUrl
- onboardingAppRootCertificate
- onboardingEnterpriseEndpoint
properties:
onboardingAppUrl:
type: string
format: iri-reference
title: Onboarding application URL
description:
The URL of the onboarding application which
can be used to access the application. This
attribute is provided by the onboarding
application when it creates the SCIM object
for the device.
example: https//example.com/onboardingapp/
onboardingAppRootCertificate:
type: string
title: The root certificate of onboarding application
description:
This attribute comprises of the
root certificate signed by the root
CA. Onboarding application provides this
attribute when it creates the SCIM object for
the device.
onboardingEnterpriseEndpoint:
type: string
format: iri-reference
title: Enterprise endpoint for onboarding app
description:
The URL of the enterprise endpoint which
oboarding app uses to reach enterprise network
gateway. This attribute is already known to
the onboarding app and adds it to the SCIM
object, when it creates the SCIM object for
the device.
example: https//enterprise.com/onboardingapp_endpoint/
deviceControl:
type: object
title: Device Control
description: Device controll application attributes.
required:
- deviceControlApps
- deviceControlEnterpriseEndpoint
properties:
deviceControlApps:
type: array
items:
type: object
title: Device control apps
description:
The list of device control apps where each
list entry contains i) URL and ii) root
certificate for each device control app that
can control the device.
properties:
deviceControlAppUrl:
type: string
format: iri-reference
title: Device control app url
description:
The URL of the device control application
which can be used to access the app. This
attribute is provided by the onboarding
application when it creates the SCIM object
for the device.
example: https//example.com/device_control_app1/
deviceControlAppRootCertificate:
type: string
title: Device control root certificate
description:
This attribute comprises of the root
certificate signed by the root CA. This
attribute is already known to the onboarding
app and adds it to the SCIM object, when it
creates the SCIM object for the device.
deviceControlEnterpriseEndpoint:
type: string
format: iri-reference
title: Device control enterprise endpoint
description:
The URL of the enterprise endpoint which
device control apps uses to reach enterprise
network gateway. When enterprise receives the
SCIM object from onboarding app, it adds this
attribute to the object and sends back the
object as response back to the onboarding
app.
example: https//enterprise.com/device_control_endpoint/
dataReceiver:
type: object
title: Data Receiver
description: Data receiver application attributes.
required:
- dataReceiverApps
- dataReceiverEnterpriseEndpoint
properties:
dataReceiverApps:
type: array
items:
type: object
title: Data receiver apps
description:
The list of data receiver apps
where each list entry contains i) URL and ii)
root certificate for each of the data receiver
app.
properties:
dataReceiverAppUrl:
type: string
format: iri-reference
title: Data receiver app URL
description:
The URL of the data receiver application
which can be used to access the
application. This attribute is provided by the
device control app when it communicates with
the controller. Controller will add this in
the SCIM object locally stored in the SCIM
server.
example: https//example.com/dataReceoiverapp1/
dataReceiverAppRootCertificate:
type: string
title: Data receiver root certificate
description:
This attribute comprises of the root
certificate signed by the root CA. This
attribute is provided by the device control
app when it communicates with the
controller. Controller will add this in the
SCIM object locally stored in the SCIM
server.
dataReceiverEnterpriseEndpoint:
type: string
format: iri-reference
title: Data receiver enterprise endpoint
description:
The URL of the enterprise endpoint which data
receiver apps uses to reach enterprise network
gateway. When enterprise receives the SCIM
object from onboarding app, it adds this
attribute to the object and sends back the
object as response back to the onboarding
app.
example: https//enterprise.com/data_receiver_endpoint/
ZigbeeDevice:
title: SCIM device Zigbee schema
allOf:
- $ref: "#/components/schemas/Device"
- type: object
required:
- adminState
- connectivity
- meta
properties:
urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device:
type: object
title: Device extension schema for zigbee.
required:
- versionSupport
- deviceEui64Address
properties:
versionSupport:
type: array
items:
type: string
title: Version support
description:
Provides a list of all the zigbee versions
supported by the device.
example: '3.0'
deviceEui64Address:
type: string
title: EUI-64 address
description:
The EUI-64 (Extended Unique Identifier) device address.
pattern: ^[0-9A-Fa-f]{16}$
example: 50325FFFFEE76728
urn:ietf:params:scim:schemas:extension:Endpoints:2.0:Device:
type: object
title: Endpoints extension schema for partner application
description:
Endpoint schema contains URLs and root certificates
for the partner application and URLs for enterprise
endpoints.
required:
- onboarding
- deviceControl
- dataReceiver
properties:
onboarding:
type: object
title: Onboarding
description: Onboarding application attributes.
required:
- onboardingAppUrl
- onboardingAppRootCertificate
- onboardingEnterpriseEndpoint
properties:
onboardingAppUrl:
type: string
format: iri-reference
title: Onboarding application URL
description:
The URL of the onboarding
application which can be used to access the
application. This attribute is provided by the
onboarding application when it creates the
SCIM object for the device.
example: https//example.com/onboardingapp/
onboardingAppRootCertificate:
type: string
title: The root certificate of onboarding application
description:
This attribute comprises of the root
certificate signed by the root CA. Onboarding
application provides this attribute when it
creates the SCIM object for the device.
onboardingEnterpriseEndpoint:
type: string
format: iri-reference
title: Enterprise endpoint for onboarding app
description:
The URL of the enterprise endpoint which
oboarding app uses to reach enterprise network
gateway. This attribute is already known to
the onboarding app and adds it to the SCIM
object, when it creates the SCIM object for
the device.
example: https//enterprise.com/onboardingapp_endpoint/
deviceControl:
type: object
title: Device Control
description: Device controll application attributes.
required:
- deviceControlApps
- deviceControlEnterpriseEndpoint
properties:
deviceControlApps:
type: array
items:
type: object
title: Device control apps
description:
The list of device control apps where each
list entry contains i) URL and ii) root
certificate for each device control app that
can control the device.
properties:
deviceControlAppUrl:
type: string
format: iri-reference
title: Device control app url
description:
The URL of the device control application
which can be used to access the app. This
attribute is provided by the onboarding
application when it creates the SCIM
object for the device.
example: https//example.com/device_control_app1/
deviceControlAppRootCertificate:
type: string
title: Device control root certificate
description:
This attribute comprises of the root
certificate signed by the root CA. This
attribute is already known to the
onboarding app and adds it to the SCIM
object, when it creates the SCIM object
for the device.
deviceControlEnterpriseEndpoint:
type: string
format: iri-reference
title: Device control enterprise endpoint
description:
The URL of the enterprise endpoint which
device control apps uses to reach enterprise
network gateway. When enterprise receives the
SCIM object from onboarding app, it adds this
attribute to the object and sends back the
object as response back to the onboarding
app.
example: https//enterprise.com/device_control_endpoint/
dataReceiver:
type: object
title: Data Receiver
description: Data receiver application attributes.
required:
- dataReceiverApps
- dataReceiverEnterpriseEndpoint
properties:
dataReceiverApps:
type: array
items:
type: object
title: Data receiver apps
description:
The list of data receiver apps where each list
entry contains i) URL and ii) root certificate
for each of the data receiver app.
properties:
dataReceiverAppUrl:
type: string
format: iri-reference
title: Data receiver app URL
description:
The URL of the data receiver application
which can be used to access the
application. This attribute is provided by
the device control app when it
communicates with the
controller. Controller will add this in
the SCIM object locally stored in the SCIM
server.
example: https//example.com/dataReceoiverapp1/
dataReceiverAppRootCertificate:
type: string
title: Data receiver root certificate
description:
This attribute comprises of the root
certificate signed by the root CA. This
attribute is provided by the device
control app when it communicates with the
controller. Controller will add this in
the SCIM object locally stored in the SCIM
server.
dataReceiverEnterpriseEndpoint:
type: string
format: iri-reference
title: Data receiver enterprise endpoint
description:
The URL of the enterprise endpoint which data
receiver apps uses to reach enterprise
network gateway. When enterprise receives
the SCIM object from onboarding app, it
adds this attribute to the object and
sends back the object as response back to
the onboarding app.
example: https//enterprise.com/data_receiver_endpoint/
WifiDevice:
title: SCIM device WiFi schema
allOf:
- $ref: "#/components/schemas/Device"
- type: object
required:
- adminState
- connectivity
- meta
properties:
urn:ietf:params:scim:schemas:extension:Wifi:2.0:Device:
type: object
title: Device extension schema for WiFi
required:
- versionSupport
- bootstrapKey
properties:
versionSupport:
type: array
items:
type: string
title: Version support
description:
Provides a list of all the WiFi versions supported
by the device.
example: 802.11ax
bootstrappingMethod:
type: array
items:
type: string
title: Bootstrapping method
description:
The list of all the bootstrapping methods
available on the enrollee device.
example: QR
bootstrapKey:
type: string
title: Bootstrap key
description:
This key is Elliptic-Curve Diffie–Hellman (ECDH)
public key. The base64 encoded length for P-256,
P-384, and P-521 is 80, 96, and 120 characters.
example: MDkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDIgADURzxmttZoIRIPWGoQMV00XHWCAQIhXruVWOz0NjlkIA=
deviceMacAddress:
type: string
title: Device MAC address
description:
The MAC address assigned by the manufacturer. It
is unique 48 bit value.
pattern: ^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$
example: 01:23:45:67:89:AB
classChannel:
type: array
items:
type: string
title: Class channel
description:
A list of global operating class and channel
shared as bootstrapping information. It is
formatted as class/channel.
example: 81/1
serialNumber:
type: string
title: Serial number
description:
An alphanumeric serial number that may also be
passed as bootstrapping information.
example: 4774LH2b4044
urn:ietf:params:scim:schemas:extension:Endpoints:2.0:Device:
type: object
title: Endpoints extension schema for partner application
description:
Endpoint schema contains URLs and root certificates
for the partner application and URLs for
enterprise endpoints.
required:
- onboarding
- deviceControl
- dataReceiver
properties:
onboarding:
type: object
title: Onboarding
description: Onboarding application attributes.
required:
- onboardingAppUrl
- onboardingAppRootCertificate
- onboardingEnterpriseEndpoint
properties:
onboardingAppUrl:
type: string
format: iri-reference
title: Onboarding application URL
description:
The URL of the onboarding application which
can be used to access the application. This
attribute is provided by the onboarding
application when it creates the SCIM object
for the device.
example: https//example.com/onboardingapp/
onboardingAppRootCertificate:
type: string
title: The root certificate of onboarding application
description:
This attribute comprises of the root
certificate signed by the root CA. Onboarding
application provides this attribute when it
creates the SCIM object for the device.
onboardingEnterpriseEndpoint:
type: string
format: iri-reference
title: Enterprise endpoint for onboarding app
description:
The URL of the enterprise endpoint which
oboarding app uses to reach enterprise network
gateway. This attribute is already known to
the onboarding app and adds it to the SCIM
object, when it creates the SCIM object for
the device.
example: https//enterprise.com/onboardingapp_endpoint/
deviceControl:
type: object
title: Device Control
description: Device controll application attributes.
required:
- deviceControlApps
- deviceControlEnterpriseEndpoint
properties:
deviceControlApps:
type: array
items:
type: object
title: Device control apps
description:
The list of device control apps where each
list entry contains i) URL and ii) root
certificate for each device control app that
can control the device.
properties:
deviceControlAppUrl:
type: string
format: iri-reference
title: Device control app url
description:
The URL of the device control application
which can be used to access the app. This
attribute is provided by the onboarding
application when it creates the SCIM
object for the device.
example: https//example.com/device_control_app1/
deviceControlAppRootCertificate:
type: string
title: Device control root certificate
description:
This attribute comprises of the root
certificate signed by the root CA. This
attribute is already known to the
onboarding app and adds it to the SCIM
object, when it creates the SCIM object
for the device.
deviceControlEnterpriseEndpoint:
type: string
format: iri-reference
title: Device control enterprise endpoint
description:
The URL of the enterprise endpoint which
device control apps uses to reach enterprise
network gateway. When enterprise receives the
SCIM object from onboarding app, it adds this
attribute to the object and sends back the
object as response back to the onboarding
app.
example: https//enterprise.com/device_control_endpoint/
dataReceiver:
type: object
title: Data Receiver
description: Data receiver application attributes.
required:
- dataReceiverApps
- dataReceiverEnterpriseEndpoint
properties:
dataReceiverApps:
type: array
items:
type: object
title: Data receiver apps
description:
The list of data receiver apps where each list
entry contains i) URL and ii) root certificate
for each of the data receiver app.
properties:
dataReceiverAppUrl:
type: string
format: iri-reference
title: Data receiver app URL
description:
The URL of the data receiver application
which can be used to access the
application. This attribute is provided by
the device control app when it
communicates with the
controller. Controller will add this in
the SCIM object locally stored in the SCIM
server.
example: https//example.com/dataReceoiverapp1/
dataReceiverAppRootCertificate:
type: string
title: Data receiver root certificate
description:
This attribute comprises of the root
certificate signed by the root CA. This
attribute is provided by the device
control app when it communicates with the
controller. Controller will add this in
the SCIM object locally stored in the SCIM
server.
dataReceiverEnterpriseEndpoint:
type: string
format: iri-reference
title: Data receiver enterprise endpoint
description:
The URL of the enterprise endpoint which data
receiver apps uses to reach enterprise network
gateway. When enterprise receives the SCIM
object from onboarding app, it adds this
attribute to the object and sends back the
object as response back to the onboarding
app.
example: https//enterprise.com/data_receiver_endpoint/
BulkRequest:
type: object
title: SCIM Bulk request
required:
- schemas
- Operations
properties:
schemas:
type: array
example: urn:ietf:params:scim:api:messages:2.0:BulkRequest
items: {}
x-item:
type: string
Operations:
type: array
items:
type: object
title: Operation
required:
- method
- bulkId
- path
- data
properties:
method:
type: string
example: POST
bulkId:
type: string
example: user1
path:
type: string
example: /Users
data:
oneOf:
- $ref: "#/components/schemas/Device"
- $ref: "#/components/schemas/BLEDevice"
- $ref: "#/components/schemas/WifiDevice"
- $ref: "#/components/schemas/ZigbeeDevice"
BulkResponse:
type: object
title: SCIM Bulk response
required:
- schemas
- Operations
properties:
schemas:
type: array
example: urn:ietf:params:scim:api:messages:2.0:BulkResponse
items: {}
x-item:
type: string
Operations: