Network Working Group M. Shahzad Internet-Draft H. Iqbal Intended status: Standards Track North Carolina State University Expires: 4 December 2023 E. Lear Cisco Systems 2 June 2023 Device Schema Extensions to the SCIM model draft-shahzad-scim-device-model-05 Abstract The initial core schema for SCIM (System for Cross Identity Management) was designed for provisioning users. This memo specifies schema extensions that enables provisioning of devices, using various underlying bootstrapping systems, such as Wifi EasyConnect, RFC 8366 vouchers, and BLE passcodes. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on 4 December 2023. Copyright Notice Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved. Shahzad, et al. Expires 4 December 2023 [Page 1] Internet-Draft SCIM Device Schema Extensions June 2023 This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/ license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Why SCIM for devices? . . . . . . . . . . . . . . . . . . 3 1.2. Protocol Participants . . . . . . . . . . . . . . . . . . 4 1.3. Schema Description . . . . . . . . . . . . . . . . . . . 5 1.4. Schema Representation . . . . . . . . . . . . . . . . . . 5 1.5. Terminology . . . . . . . . . . . . . . . . . . . . . . . 5 2. ResourceType Device . . . . . . . . . . . . . . . . . . . . . 5 2.1. Common Attributes . . . . . . . . . . . . . . . . . . . . 5 3. SCIM Core Device Schema . . . . . . . . . . . . . . . . . . . 6 3.1. Singular Attributes . . . . . . . . . . . . . . . . . . . 6 4. Device Groups . . . . . . . . . . . . . . . . . . . . . . . . 7 5. Resource Type EndpointApp . . . . . . . . . . . . . . . . . . 8 6. SCIM EndpointApp Schema . . . . . . . . . . . . . . . . . . . 8 6.1. Common Attributes . . . . . . . . . . . . . . . . . . . . 8 6.2. Singular Attributes . . . . . . . . . . . . . . . . . . . 8 6.3. Complex Attribute . . . . . . . . . . . . . . . . . . . . 9 7. SCIM Device Extensions . . . . . . . . . . . . . . . . . . . 10 7.1. BLE Extension . . . . . . . . . . . . . . . . . . . . . . 11 7.1.1. Singular Attributes . . . . . . . . . . . . . . . . . 11 7.1.2. Multivalued Attributes . . . . . . . . . . . . . . . 11 7.1.3. BLE Pairing Method Extensions . . . . . . . . . . . . 12 7.2. DPP EasyConnect Extension . . . . . . . . . . . . . . . . 15 7.2.1. Singular Attributes . . . . . . . . . . . . . . . . . 15 7.2.2. Multivalued Attributes . . . . . . . . . . . . . . . 16 7.3. Zigbee Extension . . . . . . . . . . . . . . . . . . . . 17 7.3.1. Singular Attribute . . . . . . . . . . . . . . . . . 18 7.3.2. Multivalued Attribute . . . . . . . . . . . . . . . . 18 7.4. The Endpoint Applications Extension Schema . . . . . . . 19 7.4.1. Singular Attributes . . . . . . . . . . . . . . . . . 19 7.4.2. Multivalued Attribute . . . . . . . . . . . . . . . . 20 8. Schema JSON Representation . . . . . . . . . . . . . . . . . 22 8.1. Resource Schema . . . . . . . . . . . . . . . . . . . . . 22 8.2. Device Core Schema JSON . . . . . . . . . . . . . . . . . 24 8.3. EndpointApp Schema JSON . . . . . . . . . . . . . . . . . 25 8.4. BLE Extension Schema JSON . . . . . . . . . . . . . . . . 28 8.5. DPP Extension Schema JSON . . . . . . . . . . . . . . . . 32 8.6. Zigbee Extension Schema JSON . . . . . . . . . . . . . . 34 Shahzad, et al. Expires 4 December 2023 [Page 2] Internet-Draft SCIM Device Schema Extensions June 2023 8.7. EndpointAppsExt JSON Extension Schema . . . . . . . . . . 35 9. Security Considerations . . . . . . . . . . . . . . . . . . . 37 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38 11. Changes from Earlier Versions . . . . . . . . . . . . . . . . 38 12. OpenAPI representation . . . . . . . . . . . . . . . . . . . 38 12.1. Device Core Schema OpenAPI Representation . . . . . . . 38 12.2. EndpointApp Schema OpenAPI Representation . . . . . . . 40 12.3. BLE Extension Schema OpenAPI Representation . . . . . . 44 12.4. DPP Extension Schema OpenAPI Representation . . . . . . 47 12.5. Zigbee Extension Schema OpenAPI Representation . . . . . 49 12.6. EndpointAppsExt Extension Schema OpenAPI Representation . . . . . . . . . . . . . . . . . . . . . 50 13. Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 14. TBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 15. References . . . . . . . . . . . . . . . . . . . . . . . . . 52 15.1. Normative References . . . . . . . . . . . . . . . . . . 52 15.2. Informative References . . . . . . . . . . . . . . . . . 53 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 1. Introduction The Internet of Things presents a management challenge in many dimensions. One of them is the ability to onboard and manage large number of devices. There are many models for bootstrapping trust between devices and network deployments. Indeed it is expected that different manufacturers will make use of different methods. SCIM (System for Cross Identity Management) [RFC7643] [RFC7644] defines a protocol and a schema for provisioning of users. However, it can easily be extended to provision devices. The protocol and core schema were designed to permit just such extensions. Bulk operations are supported. This is good because often devices are procured in bulk. 1.1. Why SCIM for devices? Some might ask why SCIM is well suited for this purpose and not, for example, NETCONF or RESTCONF with YANG. After all, there are all sorts of existing models available. The answer is that the only information being passed about the device is neither state nor device configuration information, but only information necessary to bootstrap trust so that the device may establish connectivity. Shahzad, et al. Expires 4 December 2023 [Page 3] Internet-Draft SCIM Device Schema Extensions June 2023 1.2. Protocol Participants In the normal SCIM model, it was presumed that large federated deployments would be SCIM clients who provision and remove employees and contractors as they are enter and depart those deployments, and federated services such as sales, payment, or conferencing services would be the servers. In the device model, the roles are reversed, and may be somewhat more varied. A deployment network management system gateway (NMS gateway) plays the role of the server, receiving information about devices that are expected to be connected to its network. That server will apply appropriate local policies regarding whether/how the device should be connected. The client may be one of a number of entities: * A vendor who is authorized to add devices to a network as part of a sales transaction. This is similar to the sales integration sometimes envisioned by Bootstrapping Remote Key Infrastructure (BRSKI) [RFC8995]. * A client application that administrators or employees use to add, remove, or get information about devices. An example might be an tablet or phone app that scans Easyconnect QR codes. +-----------------------------------+ | | +-----------+ Request | +---------+ | | onboarding|------------->| SCIM | | | app |<-------------| Server | | +-----------+ Ctrl Endpt +---------+ | | | +-----------+ | +------------+ +-------+ | | Control |...........|..| ALG |.........|device | | | App | | +------------+ +-------+ | +-----------+ | | | | +-----------------------------------+ Figure 1: Basic Architecture In Figure 1, the onboarding app provides the device particulars. As part of the response, the SCIM server might provide additional information, especially in the case of non-IP devices, where an application-layer gateway may need to be used to communicate with the device. The control endpoint is one among a number of objects that may be returned. Shahzad, et al. Expires 4 December 2023 [Page 4] Internet-Draft SCIM Device Schema Extensions June 2023 1.3. Schema Description RFC 7643 does not prescribe a language to describe a schema. We have chosen the JSON schema language [I-D.bhutton-json-schema] for this purpose. This implies that use of XML for this device extension is not supported. Several additional schemas specify specific onboarding mechanisms, such as BLE and Wifi Easy Connect. 1.4. Schema Representation Attributes defined in the device core schema and extensions comprise characteristics and SCIM datatypes defined in Sections 2.2 and 2.3 of the [RFC7643]. This RFC does not define new characteristics and datatypes for the SCIM attributes. 1.5. Terminology The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 2. ResourceType Device This section defines a new resource type, 'Device'. The "ResourceType" schema specifies the metadata about a resource type (see section 6 of [RFC7643]). The resource "Devices" comprises a core device schema and several extension schemas. The core schema provides a minimal resource representation, whereas extension schemas extend the core schema depending on the device's capability. The JSON schema for Device resource type is in Section 8.1. 2.1. Common Attributes The Device schema contains three common attributes as defined in the [RFC7643]. id An id is a required and unique attribute of the device core schema (see section 3.1 of [RFC7643]). externalID Shahzad, et al. Expires 4 December 2023 [Page 5] Internet-Draft SCIM Device Schema Extensions June 2023 An externalID is an optional attribute (see section 3.1 of [RFC7643]). meta Meta is a complex attribute and is required (see section 3.1 of [RFC7643]). 3. SCIM Core Device Schema The core device schema provides the minimal representation of a resource "Device". It contains only those attributes that any device may need. Not all attributes are optional. The core schema for "Device" is identified using the schema URI: "urn:ietf:params:scim:schemas:core:2.0:Device". The following attributes are defined in the device core schema. 3.1. Singular Attributes deviceDisplayName This attribute is of type "string" and provides a human-readable name for a device. It is intended to be displayed to end-users and should be suitable for that purpose. The attribute is not required, and is not case-sensitive. The attribute may be modified and should be returned by default. No uniqueness constraints are imposed on this attribute. adminState The "adminState" attribute is of type "boolean" and is a mutable attribute. If set to TRUE, the commands such as connect, disconnect, subscribe that control app sends to the controller for the devices will be processed by the controller. If set to FALSE, any command coming from the control app for the device will be rejected by the controller. This attribute is required and mutable. The attribute should be returned by default and there is uniqueness contraint on the attribute. mudUrl The mudUrl attribute represents the URL to the MUD file associated with this device. This attribute is optional and mutable. The mudUrl value is case sensitive and not unique. When present, this attribute may be used as described in [RFC8520]. This attribute is case sensitive and returned by default. Shahzad, et al. Expires 4 December 2023 [Page 6] Internet-Draft SCIM Device Schema Extensions June 2023 +===================+=======+=====+======+=========+========+========+ | Attribute | Multi | Req | Case | Mutable | Return | Unique | | | Value | | Exact| | | | +===================+=======+=====+======+=========+========+========+ | deviceDisplayName | F | F | F | RW | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | adminState | F | T | F | RW | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | mudUrl | F | F | T | RW | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ Figure 2: Characteristics of device schema attributes. (Req = Required, T = True, F = False, RW = ReadWrite, and Def = Default) An example of a device SCIM object is as follows: { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Device"], "id": "e9e30dba-f08f-4109-8486-d5c6a3316111", "deviceDisplayName": "BLE Heart Monitor", "adminState": true, "meta": { "resourceType": "Device", "created": "2022-01-23T04:56:22Z", "lastModified": "2022-05-13T04:42:34Z", "version": "W\/\"a330bc54f0671c9\"", "location": "https://example.com/v2/Device/e9e30dba-f08f -4109-8486-d5c6a3316111" } } The schema for the device is presented in JSON format in Section Section 8.2, while the openAPI representation is provided in Section Section 12.1. 4. Device Groups Device groups are created using the SCIM groups as defined in [RFC7643] Section 4.2. Shahzad, et al. Expires 4 December 2023 [Page 7] Internet-Draft SCIM Device Schema Extensions June 2023 5. Resource Type EndpointApp This section defines a new resource type, 'EndpointApp'. The "ResourceType" schema specifies the metadata about a resource type (see section 6 of [RFC7643]). The resource "EndpointApp" represents partner applications that can control and/or receive data from the devices. The JSON schema for EndpointApp resource type is in Section 8.1. The attributes comprising EndpointsApp are listed in Section 6. The "EndpointApp" are included in the endpoint applications extension ("endpointAppsExt") Section 7.4. 6. SCIM EndpointApp Schema The schema for "EndpointApp" is identified using the schema URI: "urn:ietf:params:scim:schemas:core:2.0:EndpointApp". The following attributes are defined in this schema. 6.1. Common Attributes The EndpointApp schema contains three common attributes as defined in the [RFC7643]. 6.2. Singular Attributes applicationType This attribute is of type "string" and represents the type of application. It will only contain two values; 'deviceControl' or 'telemetry'. 'deviceControl' is the application that sends commands to control the device. 'telemetry' is the application that receives data from the device. The attribute is required, and is not case- sensitive. The is attribute readOnly and should be returned by default. No uniqueness constraints are imposed on this attribute. applicationName The "applicationName" attribute is of type "string" and represents a human readable name for the application. This attribute is required and mutable. The attribute should be returned by default and there is no uniqueness contraint on the attribute. client-token This attribute type string contains a token that the client will use to authenticate itself. Each token may be a string up to 500 characters in length. It is mutable, required, case sensitive and returned by default if exists. Shahzad, et al. Expires 4 December 2023 [Page 8] Internet-Draft SCIM Device Schema Extensions June 2023 6.3. Complex Attribute certificateInfo It is the complex attribute that Contains x509 certificate's subject name and root CA information associated with the device control or telemetry app. It further has three attributes that are described below. rootCN It is the root certificate common name. This attribute is required, read only, singular and case sensitive. subjectName Also known as the Common Name (CN), the Subject Name is a field in the X.509 certificate that identifies the primary domain or IP address for which the certificate is issued. This attribute is not required, read only, singular and case sensitive. subjectAlternativeName This attribute allows for the inclusion of multiple domain names and IP addresses in a single certificate. This enables the certificate to be used for multiple related domains or IPs without the need for separate certificates for each. This attribute is not required, read only, multivalued and case sensitive. +===================+=======+=====+======+=========+========+========+ | Attribute | Multi | Req | Case | Mutable | Return | Unique | | | Value | | Exact| | | | +===================+=======+=====+======+=========+========+========+ | applicationType | F | T | F | R | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | applicationName | F | T | F | RW | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | client-token | F | T | T | RW | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | certificateInfo | F | F | F | R | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | rootCN | F | T | T | R | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | subjectName | F | F | T | R | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ | subjectAltName | T | F | T | R | Def | None | +-------------------+-------+-----+------+---------+--------+--------+ Shahzad, et al. Expires 4 December 2023 [Page 9] Internet-Draft SCIM Device Schema Extensions June 2023 Figure 3: Characteristics of EndpointApp schema attributes. (Req = Required, T = True, F = False, R = ReadOnly, RW = ReadWrite, Manuf = Manufactirer and Def = Default) Note that attributes client-token and certificateInfo are used for the authentication of the application. Both SHALL NOT exist together in the SCIM object. Either client-token or certificateInfo SHALL be present in the SCIM object. An example of a endpointApp SCIM object is as follows. Note that since certificateInfo is present in the example, client-token attribute is NULL. { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:EndpointApp"], "id": "e9e30dba-f08f-4109-8486-d5c6a3316212", "applicationType": "deviceControl", "applicationName": "Device Control App 1", "certificateInfo": { "rootCN": "DigiCert Global Root CA", "subjectName": "wwww.example.com", "subjectAlternativeName": ["xyz.example.com", "abc.example.com"] }, "client-token": null, "meta": { "resourceType": "EndpointApp", "created": "2022-01-23T04:56:22Z", "lastModified": "2022-05-13T04:42:34Z", "version": "W\/\"a330bc54f0671c9\"", "location": "https://example.com/v2/EndpointApp/e9e30dba-f08f -4109-8486-d5c6a3316212" } } The schema for the endpointApp is presented in JSON format in Section Section 8.3, while the openAPI representation is provided in Section Section 12.2. 7. SCIM Device Extensions SCIM provides various extension schemas, their attributes, JSON representation, and example object. These schemas extend the core device schema based on the device's capability (communication stack). This RFC presents an additional hierarchical level by introducing extensions within an extension. See below for more details. Shahzad, et al. Expires 4 December 2023 [Page 10] Internet-Draft SCIM Device Schema Extensions June 2023 [[ DISCUSS: Is this okay with the working group? ]] 7.1. BLE Extension This schema extends the device schema to represent the devices supporting BLE. The extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:ble:2.0:Device The attributes are as follows: 7.1.1. Singular Attributes deviceMacAddress A string value that represent a public MAC address assigned by the manufacturer. It is a unique 48-bit value. Ir is required, case insensitive, and it is mutable and return as default. The regex pattern is the following: ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5} isRandom A boolean flag taken from the BLE core specification, 5.3. If FALSE, the device is using a public MAC address. If TRUE, the device uses a Random address resolved using IRK. This attribute is not required, it is mutable, and returned by default. Its default value is FALSE. separateBroadcastaddress When present, this address is used for broadcasts/advertisements. This value MUST NOT be set when an IRK is provided. Its form is the same as deviceMacAddress. It is not required, multivalued, mutable, and returned by default. irk A string value, Identity resolving key, which is unique for every device. It is used to resolve the random address. It is required when addressType is TRUE. It is mutable and return by default. 7.1.2. Multivalued Attributes versionSupport Shahzad, et al. Expires 4 December 2023 [Page 11] Internet-Draft SCIM Device Schema Extensions June 2023 A multivalued attribute that provides all the BLE versions supported by the device in the form of an array. For example, [4.1, 4.2, 5.0, 5.1, 5.2, 5.3]. It is required, mutable, and return as default. pairingMethods An array of pairing methods associated with the BLE device. The pairing methods may require sub-attributes, such as key/password, for the device pairing process. To enable the scalability of pairing methods in the future, they are represented as extensions to incorporate various attributes that are part of the respective pairing process. Pairing method extensions are nested inside the BLE extension. It is required, case sensitive, mutable, and returned by deafult. 7.1.3. BLE Pairing Method Extensions The details on pairing methods and their associated attributes are in section 2.3 of [BLE53]. This memo defines extensions for four pairing methods that are nested insided the BLE extension schema. Each extension contains the common attributes Section 2.1. These extension are are as follows. (i) pairingNull extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device pairingNull does not have any attribute. It allows pairing for BLE devices that do not require a pairing method. (ii) pairingJustWorks extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0:Device Just works pairing method does not require a key to pair devices. For completeness, the key attribute is included and is set to 'null'. Key attribute is required, immutable, and return by default. (iii) pairingPassKey extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0:Device Shahzad, et al. Expires 4 December 2023 [Page 12] Internet-Draft SCIM Device Schema Extensions June 2023 The pass key pairing method requires a 6-digit key to pair devices. This extension has one singular integer attribute, "key", which is required, mutable and returned by default. The key pattern is as follows: ^[0-9]{6}$ (iv) pairingOOB extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:pairingOOB:2.0:Device The out-of-band pairing method includes three singular attributes, i.e., key, randomNumber, and confirmationNumber. key The key is string value, required and received from out-of-bond sources such as NFC. It is case sensitive, mutable, and returned by default. randomNumber It represents a nounce added to the key. It is and integer value that is required attribute. It is mutable and returned by default. confirmationNumber An integer which some solutions require in RESTful message exchange. It is not required. It is mutable and returned by default if it exists. +====================+=======+=====+======+=========+========+========+ | Attribute | Multi | Req | Case | Mutable | Return | Unique | | | Value | | Exact| | | | +====================+=======+=====+======+=========+========+========+ | deviceMacAddress | F | T | F | RW | Def | Manuf | +--------------------+-------+-----+------+---------+--------+--------+ | isRandom | F | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | sepBroadcastAdd | F | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | irk | F | F | F | RW | Def | Manuf | +--------------------+-------+-----+------+---------+--------+--------+ | versionSupport | T | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | pairingMethods | T | T | T | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ Figure 4: Characteristics of BLE extension schema attributes. sepBroadcastAdd is short for separateBroadcastaddress. (Req = Required, T = True, F = False, RW = ReadWrite, Def = Default, and Manuf = Manufacturer). Shahzad, et al. Expires 4 December 2023 [Page 13] Internet-Draft SCIM Device Schema Extensions June 2023 An example of a device object with BLE extension is as follows: { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Device", "urn:ietf:params:scim:schemas:extension:ble:2.0:Device"], "id": "e9e30dba-f08f-4109-8486-d5c6a3316111", "deviceDisplayName": "BLE Heart Monitor", "adminState": true, "urn:ietf:params:scim:schemas:extension:ble:2.0:Device" : { "versionSupport": ["5.3"], "deviceMacAddress": "2C:54:91:88:C9:E2", "isRandom": false, "separateBroadcastAddress": ["AA:BB:88:77:22:11", "AA:BB:88:77 :22:12"], "pairingMethods": ["urn:ietf:params:scim:schemas:extension :pairingNull:2.0:Device", "urn:ietf:params:scim:schemas:extension:pairingJustWorks :2.0:Device", "urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0 :Device", "urn:ietf:params:scim:schemas:extension:pairingOOB:2.0 :Device"], "urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device" : null, "urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0 :Device": { "key": null }, "urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0 :Device" : { "key": 123456 }, "urn:ietf:params:scim:schemas:extension:pairingOOB:2.0:Device": { "key": "TheKeyvalueRetrievedFromOOB", "randNumber": 238796813516896 } }, "meta": { "resourceType": "Device", "created": "2022-01-23T04:56:22Z", "lastModified": "2022-05-13T04:42:34Z", "version": "W\/\"a330bc54f0671c9\"", "location": "https://example.com/v2/Device/e9e30dba-f08f-4109 -8486-d5c6a3316111" } Shahzad, et al. Expires 4 December 2023 [Page 14] Internet-Draft SCIM Device Schema Extensions June 2023 } The schema for the BLE extension is presented in JSON format in Section Section 8.4, while the openAPI representation is provided in Section Section 12.3. 7.2. DPP EasyConnect Extension A schema that extends the device schema to enable WiFi EasyConnect (otherwise known as Device Provisioning Protocol). The extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:dpp:2.0:Device The attributes in this extension are adopted from [DPP2]. The attributes are as follows: 7.2.1. Singular Attributes dppVersion An integer that represents the version of DPP the device supports. This attribute is required, case insensitive, mutable, and returned by default. bootstrapKey A string value representing Elliptic-Curve Diffie–Hellman (ECDH) public key. The base64 encoded lengths for P-256, P-384, and P-521 are 80, 96, and 120 characters. This attribute is required, case- sensitive, mutable, and returned by default. deviceMacAddress The manufacturer assigns the MAC address stored as string. It is a unique 48-bit value. This attribute is optional, case insensitive, mutable, and returned by default. The regex pattern is as follows: ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5}. serialNumber An alphanumeric serial number, stored as string, may also be passed as bootstrapping information. This attribute is optional, case insensitive, mutable, and returned by default. Shahzad, et al. Expires 4 December 2023 [Page 15] Internet-Draft SCIM Device Schema Extensions June 2023 7.2.2. Multivalued Attributes bootstrappingMethod It is the array of strings of all the bootstrapping methods available on the enrollee device. For example, [QR, NFC]. This attribute is optional, case insensitive, mutable, and returned by default. classChannel This attribute is an array of strings of global operating class and channel shared as bootstrapping information. It is formatted as class/channel. For example, ['81/1','115/36']. This attribute is optional, case insensitive, mutable, and returned by default. +====================+=======+=====+======+=========+========+========+ | Attribute | Multi | Req | Case | Mutable | Return | Unique | | | Value | | Exact| | | | +====================+=======+=====+======+=========+========+========+ | dppVersion | F | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | bootstrapKey | F | T | T | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | deviceMacAddress | F | F | F | RW | Def | Manuf | +--------------------+-------+-----+------+---------+--------+--------+ | serialNumber | F | F | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | bootstrappingMethod| T | F | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | classChannel | T | F | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ Figure 5: Characteristics of DPP extension schema attributes. (Req = Required, T = True, F = False, RW = ReadWrite, Def = Default, and Manuf = Manufacturer). An example of a device object with DPP extension is below: Shahzad, et al. Expires 4 December 2023 [Page 16] Internet-Draft SCIM Device Schema Extensions June 2023 { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Device", "urn:ietf:params:scim:schemas:extension:dpp:2.0 :Device"], "id": "e9e30dba-f08f-4109-8486-d5c6a3316111", "displayName": "WiFi Heart Monitor", "adminState": true, "urn:ietf:params:scim:schemas:extension:dpp:2.0:Device" : { "dppVersion": 2, "bootstrappingMethod": ["QR"], "bootstrapKey": "MDkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDIgADURzxmt tZoIRIPWGoQMV00XHWCAQIhXruVWOz0NjlkIA=", "deviceMacAddress": "2C:54:91:88:C9:F2", "classChannel": ["81/1", "115/36"], "serialNumber": "4774LH2b4044" }, "meta": { "resourceType": "Device", "created": "2022-01-23T04:56:22Z", "lastModified": "2022-05-13T04:42:34Z", "version": "W\/\"a330bc54f0671c9\"", "location": "https://example.com/v2/Device/e9e30dba-f08f -4109-8486-d5c6a3316111" } } The schema for the DPP extension is presented in JSON format in Section Section 8.5, while the openAPI representation is provided in Section Section 12.4. 7.3. Zigbee Extension A schema that extends the device schema to enable the provisioning of Zigbee devices. The extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device It has one singular attribute and one multivalued attribute. The attributes are as follows: Shahzad, et al. Expires 4 December 2023 [Page 17] Internet-Draft SCIM Device Schema Extensions June 2023 7.3.1. Singular Attribute deviceEui64Address An EUI-64 (Extended Unique Identifier) device address stored as string. This attribute is required, case insensitive, mutable, and returned by default. The regex pattern is as follows: ^[0-9A-Fa-f]{16}$ 7.3.2. Multivalued Attribute versionSupport An array of strings of all the Zigbee versions supported by the device. For example, [3.0]. This attribute is required, case insensitive, mutable, and returned by default. +====================+=======+=====+======+=========+========+========+ | Attribute | Multi | Req | Case | Mutable | Return | Unique | | | Value | | Exact| | | | +====================+=======+=====+======+=========+========+========+ | deviceEui64Address | F | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | versionSupport | T | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ Figure 6: Characteristics of Zigbee extension schema attributes. (Req = Required, T = True, F = False, RW = ReadWrite, and Def = Default) An example of a device object with Zigbee extension is shown below: Shahzad, et al. Expires 4 December 2023 [Page 18] Internet-Draft SCIM Device Schema Extensions June 2023 { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Device", "urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device"], "id": "e9e30dba-f08f-4109-8486-d5c6a3316111", "displayName": "Zigbee Heart Monitor", "adminState": true, "urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device" : { "versionSupport": ["3.0"], "deviceEui64Address": "50325FFFFEE76728" }, "meta": { "resourceType": "Device", "created": "2022-01-23T04:56:22Z", "lastModified": "2022-05-13T04:42:34Z", "version": "W\/\"a330bc54f0671c9\"", "location": "https://example.com/v2/Device/e9e30dba-f08f-4109 -8486-d5c6a3316111" } } The schema for the Zigbee extension is presented in JSON format in Section Section 8.6, while the openAPI representation is provided in Section Section 12.5. 7.4. The Endpoint Applications Extension Schema Sometimes non-IP devices such as those using BLE or Zigbee require an application gateway interface to manage them. SCIM clients MUST NOT specify this to describe native IP-based devices. endpointAppsExt provides the list application that connect to enterprise gateway. The endpointAppsExt has one multivalued attribute and two singular attributes. The extension is identified using the following schema URI: urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0:Device 7.4.1. Singular Attributes DeviceControlEnterpriseEndpoint Device control apps use this URL of the enterprise endpoint to reach the enterprise gateway. When the enterprise receives the SCIM object from the onboarding app, it adds this attribute to it and sends it Shahzad, et al. Expires 4 December 2023 [Page 19] Internet-Draft SCIM Device Schema Extensions June 2023 back as a response to the onboarding app. This attribute is required, case-sensitive, mutable, and returned by default. The uniqueness is enforced by the enterprise. telemetryEnterpriseEndpoint Telemetry apps use this URL of the enterprise endpoint to reach the enterprise gateway. When the enterprise receives the SCIM object from the onboarding app, it adds this attribute to it and sends it back as a response to the onboarding app. This attribute is required, case-sensitive, mutable, and returned by default. The uniqueness is enforced by the enterprise. 7.4.2. Multivalued Attribute applications This is a complex multivalued attribute. It represents a list of endpoint applications i.e., deviceControl and telemetry. Each entry in the list comprises two attributes including "value" and "$ref". value It is the identifier of the endpoint application formated as UUID. It is same as the common attribute "$id" of the resource "endpointApp". It is readOnly, required, case insensitive and returned by default. $ref It is the reference to the respective endpointApp resource object stored in the SCIM server. It is readOnly, required, case sensitive and returned by default. +====================+=======+=====+======+=========+========+========+ | Attribute | Multi | Req | Case | Mutable | Return | Unique | | | Value | | Exact| | | | +====================+=======+=====+======+=========+========+========+ | DevContEntEndpoint | F | T | T | RW | Def | Ent | +--------------------+-------+-----+------+---------+--------+--------+ | telEntEndpoint | F | T | T | RW | Def | Ent | +--------------------+-------+-----+------+---------+--------+--------+ | applications | T | T | F | RW | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | value | F | T | F | R | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ | $ref | F | T | F | R | Def | None | +--------------------+-------+-----+------+---------+--------+--------+ Shahzad, et al. Expires 4 December 2023 [Page 20] Internet-Draft SCIM Device Schema Extensions June 2023 Figure 7: Characteristics of EndpointAppsExt extension schema attributes. DevContEntEndpoint represents attribute DeviceControlEnterpriseEndpoint and telEntEndpoint represents telemetryEnterpriseEndpoint. (Req = Required, T = True, F = False, R = ReadOnly, RW = ReadWrite, Ent = Enterprise, and Def = Default). An example of a device object with endpointAppsExt extension is below: { "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Device", "urn:ietf:params:scim:schemas:extension:ble:2.0:Device", "urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0 :Device"], "id": "e9e30dba-f08f-4109-8486-d5c6a3316111", "displayName": "BLE Heart Monitor", "adminState": true, "urn:ietf:params:scim:schemas:extension:ble:2.0:Device" : { "versionSupport": ["5.3"], "deviceMacAddress": "2C:54:91:88:C9:E2", "addressType": false, "pairingMethods": [ "urn:ietf:params:scim:schemas:extension:pairingNull:2.0 :Device", "urn:ietf:params:scim:schemas:extension:pairingJustWorks :2.0:Device", "urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0 :Device", "urn:ietf:params:scim:schemas:extension:pairingOOB:2.0 :Device"], "urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device" : null, "urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0 :Device": { "key": null }, "urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0 :Device" : { "key": 123456 }, "urn:ietf:params:scim:schemas:extension:pairingOOB:2.0:Device": { "key": "TheKeyvalueRetrievedFromOOB", "randNumber": 238796813516896 } Shahzad, et al. Expires 4 December 2023 [Page 21] Internet-Draft SCIM Device Schema Extensions June 2023 }, "urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0 :Device": { "applications": [ { "value" : "e9e30dba-f08f-4109-8486-d5c6a3316212", "$ref" : "https://example.com/v2/EndpointApp/e9e30dba-f08f -4109-8486-d5c6a3316212" }, { "value" : "e9e30dba-f08f-4109-8486-d5c6a3316333", "$ref" : "https://example.com/v2/EndpointApp/e9e30dba-f08f -4109-8486-d5c6a3316333" } ], "DeviceControlEnterpriseEndpoint": "https//enterprise.com/device_control_app_endpoint/", "telemetryEnterpriseEndpoint": "https//enterprise.com/telemetry_app_endpoint/" }, "meta": { "resourceType": "Device", "created": "2022-01-23T04:56:22Z", "lastModified": "2022-05-13T04:42:34Z", "version": "W\/\"a330bc54f0671c9\"", "location": "https://example.com/v2/Device/e9e30dba-f08f-4109 -8486-d5c6a3316111" } } The schema for the endpointAppsExt extension along with BLE extension is presented in JSON format in Section Section 8.7, while the openAPI representation is provided in Section Section 12.6. 8. Schema JSON Representation 8.1. Resource Schema Shahzad, et al. Expires 4 December 2023 [Page 22] Internet-Draft SCIM Device Schema Extensions June 2023 [ { "schemas": ["urn:ietf:params:scim:schemas:core:2.0 :ResourceType"], "id": "Device", "name": "Device", "endpoint": "/Device", "description": "Device Account", "schema": "urn:ietf:params:scim:schemas:core:2.0:Device", "schemaExtensions": [ { "schema": "urn:ietf:params:scim:schemas:extension:ble:2.0 :Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension:dpp:2.0 :Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension:zigbee :2.0:Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension :endpointApps:2.0:Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension :pairingNull:2.0:Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension :pairingJustWorks:2.0:Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension :pairingPassKey:2.0:Device", "required": false }, { "schema": "urn:ietf:params:scim:schemas:extension Shahzad, et al. Expires 4 December 2023 [Page 23] Internet-Draft SCIM Device Schema Extensions June 2023 :pairingOOB:2.0:Device", "required": false } ], "meta": { "location": "https://example.com/v2/ResourceTypes/Device", "resourceType": "ResourceType" } }, { "schemas": ["urn:ietf:params:scim:schemas:core:2.0 :ResourceType"], "id": "EndpointApp", "name": "EndpointApp", "endpoint": "/EndpointApp", "description": "Endpoint application such as device control and telemetry.", "schema": "urn:ietf:params:scim:schemas:core:2.0:EndpointApp", "meta": { "location": "https ://example.com/v2/ResourceTypes/EndpointApp", "resourceType": "ResourceType" } } ] 8.2. Device Core Schema JSON { "id": "urn:ietf:params:scim:schemas:core:2.0:Device", "name": "Device", "description": "Device account", "attributes" : [ { "name": "deviceDisplayName", "type": "string", "description": "Human readable name of the device, suitable for displaying to end-users. For example, 'BLE Heart Monitor' etc.", "multivalues": false, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, Shahzad, et al. Expires 4 December 2023 [Page 24] Internet-Draft SCIM Device Schema Extensions June 2023 { "name": "adminState", "type": "boolean", "description": "A mutable boolean value indicating the device administrative status. 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 comming from the control app for the device will be rejected by the controller.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "mudUrl", "type": "reference", "description": "A URL to MUD file of the device (RFC 8520).", "multivalues": false, "required": false, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Device" } } 8.3. EndpointApp Schema JSON { "id": "urn:ietf:params:scim:schemas:core:2.0:EndpointApp", "name": "EndpointApp", "description": "Endpoint application and their credentials", "attributes" : [ { "name": "applicationType", "type": "string", Shahzad, et al. Expires 4 December 2023 [Page 25] Internet-Draft SCIM Device Schema Extensions June 2023 "description": "This attribute will only contain two values; 'deviceControl' or 'telemetry'.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readOnly", "returned": "default", "uniqueness": "none" }, { "name": "applicationName", "type": "string", "description": "Human readable name of the application.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "certificateInfo", "type": "complex", "description": "Contains x509 certificate's subject name and root CA information associated with the device control or telemetry app.", "multivalues": false, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none", "subAttributes" : [ { "name" : "rootCN", "type" : "string", "description" : "A root certificate common name.", "multiValued" : false, "required" : true, "caseExact" : true, "mutability" : "readOnly", "returned" : "default", "uniqueness" : "none" }, { "name" : "subjectName", "type" : "string", "description" : "Also known as the Common Name (CN), the Shahzad, et al. Expires 4 December 2023 [Page 26] Internet-Draft SCIM Device Schema Extensions June 2023 Subject Name is a field in the X.509 certificate that identifies the primary domain or IP address for which the certificate is issued.", "multiValued" : false, "required" : false, "caseExact" : true, "mutability" : "readOnly", "returned" : "default", "uniqueness" : "none" }, { "name" : "subjectAlternativeName", "type" : "string", "description" : "This attribute allows for the inclusion of multiple domain names and IP addresses in a single certificate. This enables the certificate to be used for multiple related domains or IPs without the need for separate certificates for each.", "multiValued" : true, "required" : false, "caseExact" : true, "mutability" : "readOnly", "returned" : "default", "uniqueness" : "none" } ] }, { "name": "client-token", "type": "string", "description": "This attribute contains a token that the client will use to authenticate itself. Each token may be a string up to 500 characters in length.", "multivalues": false, "required": false, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Device" } } Shahzad, et al. Expires 4 December 2023 [Page 27] Internet-Draft SCIM Device Schema Extensions June 2023 8.4. BLE Extension Schema JSON [ { "id": "urn:ietf:params:scim:schemas:extension:ble:2.0:Device", "name": "bleExtension", "description": "Ble extension for device account", "attributes" : [ { "name": "versionSupport", "type": "string", "description": "Provides a list of all the BLE versions supported by the device. For example, [4.1, 4.2, 5.0, 5.1, 5.2, 5.3].", "multivalues": true, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "deviceMacAddress", "type": "string", "description": "It is the public MAC address assigned by the manufacturer. It is unique 48 bit value. The regex pattern is ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5}.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "Manufacturer" }, { "name": "isRandom", "type": "boolean", "description": "The isRandom flag is taken from the BLE core specifications 5.3. If TRUE, device is using Random address which is resolved using IRK. If not present, the value is FALSE.", "multivalues": false, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" Shahzad, et al. Expires 4 December 2023 [Page 28] Internet-Draft SCIM Device Schema Extensions June 2023 }, { "name": "separateBroadcastAddress", "type": "string", "description": "When present, this address is used for broadcasts/advertisements. This value MUST NOT be set when an IRK is provided. Its form is the same as deviceMa`cAddress.", "multivalues": true, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "irk", "type": "string", "description": "Identity resolving key, which is unique for every device. It is used to resolve random address. This value MUST NOT be set when separateBroadcastAddress is set.", "multivalues": false, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "Manufacturer" }, { "name": "pairingMethods", "type": "string", "description": "List of pairing methods associated with the ble device, stored as schema URI.", "multivalues": true, "required": true, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:ble:2.0:Device" } }, Shahzad, et al. Expires 4 December 2023 [Page 29] Internet-Draft SCIM Device Schema Extensions June 2023 { "id": "urn:ietf:params:scim:schemas:extension:pairingNull:2.0 :Device", "name": "nullPairing", "description": "Null pairing method for ble. It is included for the devices that do not have a pairing method.", "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:pairingNull:2.0:Device" } }, { "id": "urn:ietf:params:scim:schemas:extension:pairingJustWorks :2.0:Device", "name": "pairingJustWorks", "description": "Just works pairing method for ble.", "attributes" : [ { "name": "key", "type": "integer", "description": "Just works does not have any key value. For completeness, it is added with a key value 'null'.", "multivalues": false, "required": true, "caseExact": false, "mutability": "immutable", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:pairingJustWorks:2.0:Device" } }, { "id": "urn:ietf:params:scim:schemas:extension:pairingPassKey :2.0:Device", "name": "pairingPassKey", "description": "Pass key pairing method for ble.", "attributes" : [ { "name": "key", "type": "integer", "description": "A six digit passkey for ble device. The pattern of key is ^[0-9]{6}$.", Shahzad, et al. Expires 4 December 2023 [Page 30] Internet-Draft SCIM Device Schema Extensions June 2023 "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:pairingPassKey:2.0:Device" } }, { "id": "urn:ietf:params:scim:schemas:extension:pairingOOB:2.0 :Device", "name": "pairingOOB", "description": "Pass key pairing method for ble.", "attributes" : [ { "name": "key", "type": "string", "description": "A key value retrieved from out of band source such as NFC.", "multivalues": false, "required": true, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "randomNumber", "type": "integer", "description": "Nonce added to the key.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "confirmationNumber", "type": "integer", "description": "Some solutions require confirmation number in RESTful message exchange.", Shahzad, et al. Expires 4 December 2023 [Page 31] Internet-Draft SCIM Device Schema Extensions June 2023 "multivalues": false, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:pairingOOB:2.0:Device" } } ] 8.5. DPP Extension Schema JSON { "id": "urn:ietf:params:scim:schemas:extension:dpp:2.0:Device", "name": "dppExtension", "description": "Device extension schema for DPP", "attributes" : [ { "name": "dppVersion", "type": "integer", "description": "Version of DPP this device supports.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "bootstrappingMethod", "type": "string", "description": "The list of all the bootstrapping methods available on the enrollee device. For example, [QR, NFC].", "multivalues": true, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" Shahzad, et al. Expires 4 December 2023 [Page 32] Internet-Draft SCIM Device Schema Extensions June 2023 }, { "name": "bootstrapKey", "type": "string", "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.", "multivalues": false, "required": true, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "deviceMacAddress", "type": "string", "description": "The MAC address assigned by the manufacturer. It is unique 48 bit value. The regex pattern is ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5}.", "multivalues": false, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "Manufacturer" }, { "name": "classChannel", "type": "string", "description": "A list of global operating class and channel shared as bootstrapping information. It is formatted as class/channel. For example, '81/1', '115/36'.", "multivalues": true, "required": false, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "serialNumber", "type": "string", "description": "An alphanumeric serial number that may also be passed as bootstrapping information.", "multivalues": false, "required": false, Shahzad, et al. Expires 4 December 2023 [Page 33] Internet-Draft SCIM Device Schema Extensions June 2023 "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:dpp:2.0:Device" } } 8.6. Zigbee Extension Schema JSON Shahzad, et al. Expires 4 December 2023 [Page 34] Internet-Draft SCIM Device Schema Extensions June 2023 { "id": "urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device", "name": "zigbeeExtension", "description": "Device extension schema for zigbee.", "attributes" : [ { "name": "versionSupport", "type": "string", "description": "Provides a list of all the zigbee versions supported by the device. For example, [3.0].", "multivalues": true, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" }, { "name": "deviceEui64Address", "type": "string", "description": "The EUI-64 (Extended Unique Identifier) device address. The regex pattern is ^[0-9A-Fa-f]{16}$.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:zigbee:2.0:Device" } } 8.7. EndpointAppsExt JSON Extension Schema { "id": "urn:ietf:params:scim:schemas:extension:endpointAppsExt:2.0 :Device", "name": "endpointAppsExt", "description": "Extension for partner endpoint applications that can onboard, control, and communicate with the device.", Shahzad, et al. Expires 4 December 2023 [Page 35] Internet-Draft SCIM Device Schema Extensions June 2023 "attributes" : [ { "name": "applications", "type": "complex", "description": "Includes references to two types of application that connect with entrprise, i.e., deviceControl and telemetry.", "multivalues": false, "required": true, "caseExact": false, "mutability": "readWrite", "returned": "default", "uniqueness": "none", "subAttributes" : [ { "name" : "value", "type" : "string", "description" : "The identifier of the endpointApp.", "multiValued" : false, "required" : true, "caseExact" : false, "mutability" : "readOnly", "returned" : "default", "uniqueness" : "none" }, { "name" : "$ref", "type" : "reference", "referenceTypes" : "EndpointApps", "description" : "The URI of the corresponding 'EndpointApp' resource which will control or obtain data from the device.", "multiValued" : false, "required" : false, "caseExact" : true, "mutability" : "readOnly", "returned" : "default", "uniqueness" : "none" } ] }, { "name": "DeviceControlEnterpriseEndpoint", "type": "reference", "description": "The URL of the enterprise endpoint which device control apps use to reach enterprise network gateway.", "multivalues": false, Shahzad, et al. Expires 4 December 2023 [Page 36] Internet-Draft SCIM Device Schema Extensions June 2023 "required": true, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "Enterprise" }, { "name": "telemetryEnterpriseEndpoint", "type": "reference", "description": "The URL of the enterprise endpoint which telemetry apps use to reach enterprise network gateway.", "multivalues": false, "required": true, "caseExact": true, "mutability": "readWrite", "returned": "default", "uniqueness": "Enterprise" } ], "meta" : { "resourceType" : "Schema", "location" : "/v2/Schemas/urn:ietf:params:scim:schemas :extension:endpointAppsExt:2.0:Device" } } The following sections provide representations of schemas for both SCIM resources and service provider schemas. Note that the JSON representation has been modified for readability and to fit the specification format. 8.7.1. Resource Schema Representation The following is intended as an example of the SCIM schema representation in JSON format for SCIM resources. Where permitted, individual values and schema MAY change. This example includes schema representations for "User", "Group", and "EnterpriseUser"; other schema representations are possible. 9. Security Considerations Because provisioning operations are senstive, each client must be appropriately authenticated. Certain objects may be read-only or not visible based on who is connected. [ More to be added here. ] Shahzad, et al. Expires 4 December 2023 [Page 37] Internet-Draft SCIM Device Schema Extensions June 2023 10. IANA Considerations TBD 11. Changes from Earlier Versions Draft -01: * Doh! We forgot the core device schemea! Draft -00: * Initial revision 12. OpenAPI representation The following sections are provided for informational purposes. 12.1. Device Core Schema OpenAPI Representation OpenAPI representation of device core schema is as follows: components: schemas: Device: title: Device description: Device account type: object properties: deviceDisplayName: type: string description: "Human readable name of the device, suitable for displaying to end-users. For example, 'BLE Heart Monitor' etc." nullable: true readOnly: false writeOnly: false adminState: type: boolean description: A mutable boolean value indicating the device administrative status. 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 comming from the control app for the device will be rejected by the controller. Shahzad, et al. Expires 4 December 2023 [Page 38] Internet-Draft SCIM Device Schema Extensions June 2023 nullable: false readOnly: false writeOnly: false mudUrl: type: string format: uri description: A URL to MUD file of the device (RFC 8520). It is added for future use. Current usage is not defined yet. nullable: true readOnly: false writeOnly: false required: - adminState additionalProperties: false allOf: - $ref: '#/components/schemas/CommonAttributes' CommonAttributes: type: object properties: schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:Device description: The list of schemas that define the resource. nullable: false id: type: string format: uri description: The unique identifier for a resource. nullable: false readOnly: true writeOnly: false externalId: type: string description: An identifier for the resource that is defined by the provisioning client. nullable: true readOnly: false writeOnly: false meta: type: object readOnly: true properties: resourceType: type: string Shahzad, et al. Expires 4 December 2023 [Page 39] Internet-Draft SCIM Device Schema Extensions June 2023 description: The name of the resource type of the resource. nullable: false readOnly: true writeOnly: false location: type: string format: uri description: The URI of the resource being returned. nullable: false readOnly: true writeOnly: false created: type: string format: date-time description: The date and time the resource was added to the service provider. nullable: false readOnly: true writeOnly: false lastModified: type: string format: date-time description: The most recent date and time that the details of this resource were updated at the service provider. nullable: false readOnly: true writeOnly: false version: type: string description: The version of the resource. nullable: true readOnly: true writeOnly: false additionalProperties: false 12.2. EndpointApp Schema OpenAPI Representation OpenAPI representation of endpointApp schema is as follows: components: schemas: EndpointApp: title: EndpointApp description: Endpoint application resource Shahzad, et al. Expires 4 December 2023 [Page 40] Internet-Draft SCIM Device Schema Extensions June 2023 type: object properties: applicationType: type: string description: "This attribute will only contain two values; 'deviceControl' or 'telemetry'." nullable: false readOnly: true writeOnly: false applicationName: type: string description: Human readable name of the application. nullable: false readOnly: false writeOnly: false required: - applicationType - applicationName additionalProperties: true oneOf: - $ref: '#/components/schemas/client-token' - $ref: '#/components/schemas/certificateInfo' allOf: - $ref: '#/components/schemas/CommonAttributes' client-token: type: string description: "This attribute contains a token that the client will use to authenticate itself. Each token may be a string up to 500 characters in length." nullable: true readOnly: false writeOnly: false certificateInfo: type: object description: "Contains x509 certificate's subject name and root CA information associated with the device control or telemetry app." properties: rootCN: type: string description: "A root certificate common name." nullable: false Shahzad, et al. Expires 4 December 2023 [Page 41] Internet-Draft SCIM Device Schema Extensions June 2023 readOnly: true writeOnly: false subjectName: type: string description: "Also known as the Common Name (CN), the Subject Name is a field in the X.509 certificate that identifies the primary domain or IP address for which the certificate is issued." nullable: false readOnly: true writeOnly: false subjectAlternativeName: type: array items: type: string description: "This attribute allows for the inclusion of multiple domain names and IP addresses in a single certificate. This enables the certificate to be used for multiple related domains or IPs without the need for separate certificates for each. " nullable: true readOnly: true writeOnly: false required: - rootCN CommonAttributes: type: object properties: schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:Device description: The list of schemas that define the resource. nullable: false id: type: string format: uri description: The unique identifier for a resource. nullable: false readOnly: true writeOnly: false Shahzad, et al. Expires 4 December 2023 [Page 42] Internet-Draft SCIM Device Schema Extensions June 2023 externalId: type: string description: An identifier for the resource that is defined by the provisioning client. nullable: true readOnly: false writeOnly: false meta: type: object readOnly: true properties: resourceType: type: string description: The name of the resource type of the resource. nullable: false readOnly: true writeOnly: false location: type: string format: uri description: The URI of the resource being returned. nullable: false readOnly: true writeOnly: false created: type: string format: date-time description: The date and time the resource was added to the service provider. nullable: false readOnly: true writeOnly: false lastModified: type: string format: date-time description: The most recent date and time that the details of this resource were updated at the service provider. nullable: false readOnly: true writeOnly: false version: type: string description: The version of the resource. nullable: true readOnly: true writeOnly: false Shahzad, et al. Expires 4 December 2023 [Page 43] Internet-Draft SCIM Device Schema Extensions June 2023 additionalProperties: false 12.3. BLE Extension Schema OpenAPI Representation OpenAPI representation of BLE extension schema is as follows: components: schemas: BleDevice: type: object description: BLE Device schema. properties: schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:extension:ble:2.0:Device urn:ietf:params:scim:schemas:extension:ble:2.0:Device: $ref: '#/components/schemas/BleDeviceExtension' required: true BleDeviceExtension: type: object properties: versionSupport: type: array items: type: string description: Provides a list of all the BLE versions supported by the device. For example, [4.1, 4.2, 5.0, 5.1, 5.2, 5.3]. nullable: false readOnly: false writeOnly: false deviceMacAddress: type: string description: It is the public MAC address assigned by the manufacturer. It is unique 48 bit value. The regex pattern is ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5}. nullable: false readOnly: false writeOnly: false isRandom: Shahzad, et al. Expires 4 December 2023 [Page 44] Internet-Draft SCIM Device Schema Extensions June 2023 type: boolean 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 the IRK. nullable: false readOnly: false writeOnly: false separateBroadcastAddress: type: string description: "When present, this address is used for broadcasts/advertisements. This value MUST NOT be set when an IRK is provided. Its form is the same as deviceMa`cAddress." nullable: false readOnly: false writeOnly: false irk: type: string description: Identity resolving key, which is unique for every device. It is used to resolve random address. nullable: true readOnly: false writeOnly: false pairingMethods: type: array items: type: string description: List of pairing methods associated with the ble device, stored as schema URI. nullable: true readOnly: false writeOnly: false urn:ietf:params:scim:schemas:extension:pairingNull:2.0:Device: $ref: '#/components/schemas/NullPairing' required: false urn:ietf:params:scim:schemas:extension:pairingJustWorks:2.0:Device: $ref: '#/components/schemas/PairingJustWorks' required: false urn:ietf:params:scim:schemas:extension:pairingPassKey:2.0:Device: $ref: '#/components/schemas/PairingPassKey' required: false urn:ietf:params:scim:schemas:extension:pairingOOB:2.0:Device: $ref: '#/components/schemas/PairingOOB' Shahzad, et al. Expires 4 December 2023 [Page 45] Internet-Draft SCIM Device Schema Extensions June 2023 required: false required: - versionSupport - deviceMacAddress - AddressType - pairingMethods additionalProperties: false NullPairing: type: object properties: id: type: string description: The id of the null pairing schema. nullable: false readOnly: true writeOnly: false PairingJustWorks: type: object description: Just works pairing method for ble properties: key: type: integer description: Just works does not have any key value. For completeness, it is added with a key value 'null'. nullable: false readOnly: false writeOnly: false required: - key PairingPassKey: type: object description: Pass key pairing method for ble properties: key: type: integer description: A six digit passkey for ble device. The pattern of key is ^[0-9]{6}$. nullable: false readOnly: false writeOnly: false required: - key PairingOOB: Shahzad, et al. Expires 4 December 2023 [Page 46] Internet-Draft SCIM Device Schema Extensions June 2023 type: object description: Out-of-band pairing method for BLE properties: key: type: string description: The OOB key value for ble device. nullable: false readOnly: false writeOnly: false randomNumber: type: integer description: Nonce added to the key nullable: false readOnly: false writeOnly: false confirmationNumber: type: integer description: Some solutions require a confirmation number in the RESTful message exchange. nullable: true readOnly: false writeOnly: false required: - key - randomNumber 12.4. DPP Extension Schema OpenAPI Representation OpenAPI representation of DPP extension schema is as follows: components: schemas: DppDevice: type: object description: DPP device extension schema properties: schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:extension:dpp:2.0:Device urn:ietf:params:scim:schemas:extension:dpp:2.0:Device: $ref: '#/components/schemas/DppDeviceExtension' required: true DppDeviceExtension: Shahzad, et al. Expires 4 December 2023 [Page 47] Internet-Draft SCIM Device Schema Extensions June 2023 type: object properties: dppVersion: type: integer description: Version of DPP this device supports. nullable: false readOnly: false writeOnly: false bootstrappingMethod: type: array items: type: string description: The list of all the bootstrapping methods available on the enrollee device. For example, [QR, NFC]. nullable: true readOnly: false writeOnly: false bootstrapKey: type: string 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. nullable: false readOnly: false writeOnly: false deviceMacAddress: type: string description: The MAC address assigned by the manufacturer. The regex pattern is ^[0-9A-Fa-f]{2}(:[0-9A-Fa-f]{2}){5}. nullable: false readOnly: false writeOnly: false classChannel: type: array items: type: string description: A list of global operating class and channel shared as bootstrapping information. It is formatted as class/channel. For example, '81/1', '115/36'. nullable: false readOnly: false writeOnly: false serialNumber: type: string Shahzad, et al. Expires 4 December 2023 [Page 48] Internet-Draft SCIM Device Schema Extensions June 2023 description: An alphanumeric serial number that may also be passed as bootstrapping information. nullable: false readOnly: false writeOnly: false required: - dppVersion - bootstrapKey additionalProperties: false 12.5. Zigbee Extension Schema OpenAPI Representation OpenAPI representation of zigbee extension schema is as follows: Shahzad, et al. Expires 4 December 2023 [Page 49] Internet-Draft SCIM Device Schema Extensions June 2023 components: schemas: ZigbeeDevice: type: object description: Zigbee Device schema. properties: schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device urn:ietf:params:scim:schemas:extension:zigbee:2.0:Device: $ref: '#/components/schemas/ZigbeeDeviceExtension' required: true ZigbeeDeviceExtension: type: object properties: versionSupport: type: array items: type: string description: Provides a list of all the Zigbee versions supported by the device. For example, [3.0]. nullable: false readOnly: false writeOnly: false deviceEui64Address: type: string description: The EUI-64 (Extended Unique Identifier) device address. The regex pattern is ^[0-9A-Fa-f]{16}$. nullable: false readOnly: false writeOnly: false required: - versionSupport - deviceEui64Address description: Device extension schema for Zigbee. 12.6. EndpointAppsExt Extension Schema OpenAPI Representation OpenAPI representation of endpoint Apps extension schema is as follows: Shahzad, et al. Expires 4 December 2023 [Page 50] Internet-Draft SCIM Device Schema Extensions June 2023 components: schemas: EndpointAppsExt: type: object properties: applications: $ref: '#/components/schemas/applications' DeviceControlEnterpriseEndpoint: type: string format: url description: The URL of the enterprise endpoint which device control apps use to reach enterprise network gateway. nullable: false readOnly: false writeOnly: false telemetryEnterpriseEndpoint: type: string format: url description: The URL of the enterprise endpoint which telemetry apps use to reach enterprise network gateway. nullable: false readOnly: false writeOnly: false required: - applications - DeviceControlEnterpriseEndpoint - telemetryEnterpriseEndpoint applications: type: array items: value: type: string description: The identifier of the endpointApp. nullable: false readOnly: true writeOnly: false ref: type: string format: uri description: The URI of the corresponding 'EndpointApp' resource which will control or obtain data from Shahzad, et al. Expires 4 December 2023 [Page 51] Internet-Draft SCIM Device Schema Extensions June 2023 the device. nullable: false readOnly: true writeOnly: false required: - value - ref 13. Changes * 04 openapi model and narrative clarified. * 05 typos 14. TBD Fido 15. References 15.1. Normative References [BLE53] Bluetooth SIG, "Bluetooth Core Specification, Version 5.3", 2021. [DPP2] Wi-Fi Alliance, "Wi-Fi Easy Connect Specification, Version 2.0", 2020. [I-D.bhutton-json-schema] Wright, A., Andrews, H., Hutton, B., and G. Dennis, "JSON Schema: A Media Type for Describing JSON Documents", Work in Progress, Internet-Draft, draft-bhutton-json-schema-01, 10 June 2022, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC7643] Hunt, P., Ed., Grizzle, K., Wahlstroem, E., and C. Mortimore, "System for Cross-domain Identity Management: Core Schema", RFC 7643, DOI 10.17487/RFC7643, September 2015, . Shahzad, et al. Expires 4 December 2023 [Page 52] Internet-Draft SCIM Device Schema Extensions June 2023 [RFC7644] Hunt, P., Ed., Grizzle, K., Ansari, M., Wahlstroem, E., and C. Mortimore, "System for Cross-domain Identity Management: Protocol", RFC 7644, DOI 10.17487/RFC7644, September 2015, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8520] Lear, E., Droms, R., and D. Romascanu, "Manufacturer Usage Description Specification", RFC 8520, DOI 10.17487/RFC8520, March 2019, . 15.2. Informative References [RFC8995] Pritikin, M., Richardson, M., Eckert, T., Behringer, M., and K. Watsen, "Bootstrapping Remote Secure Key Infrastructure (BRSKI)", RFC 8995, DOI 10.17487/RFC8995, May 2021, . Authors' Addresses Muhammad Shahzad North Carolina State University Department of Computer Science 890 Oval Drive Campus Box 8206 Raleigh, NC, 27695-8206 United States of America Email: mshahza@ncsu.edu Hassan Iqbal North Carolina State University Department of Computer Science 890 Oval Drive Campus Box 8206 Raleigh, NC, 27695-8206 United States of America Email: hiqbal@ncsu.edu Eliot Lear Cisco Systems Richtistrasse 7 CH-8304 Wallisellen Switzerland Shahzad, et al. Expires 4 December 2023 [Page 53] Internet-Draft SCIM Device Schema Extensions June 2023 Phone: +41 44 878 9200 Email: lear@cisco.com Shahzad, et al. Expires 4 December 2023 [Page 54]