Skip to main content

3. SCIM Core Device Schema

This section preserves the RFC text for SCIM device schema extensions, including Device and EndpointApp resource types, BLE, DPP, Ethernet MAB, FDO, Zigbee, endpointAppsExt, JSON Schema, OpenAPI, IANA registrations, and security considerations.

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, and only one attribute is required.  It is identified using
   the schema URI:

   urn:ietf:params:scim:schemas:core:2.0:Device

   The following attributes are defined in the core device schema.

3.1.  Singular Attributes

   displayName:  A string that 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.  It may be modified and SHOULD be returned by
      default.  No uniqueness constraints are imposed on this attribute.

   active:  A mutable boolean that is required.  If set to true, it
      means that this device is intended to be operational.  Attempts to
      control or access a device where this value is set to false may
      fail.  For example, when used in conjunction with Non-Internet-
      Connected Physical Components (NIPC) [NIPC], commands (such as
      connect, disconnect, and subscribe) that control application sends
      to the controller for devices will be rejected by the controller.

   mudUrl:  A string that represents the URL to the Manufacturer Usage
      Description (MUD) file associated with this device.  This
      attribute is optional, mutable, and returned by default.  When
      present, this attribute may be used as described in [RFC8520].
      The mudUrl value is case sensitive and not unique.

   groups:  An optional read-only complex object that indicates group
      membership.  Its form is precisely the same as that defined in
      Section 4.1.2 of [RFC7643].

     +=============+=======+=====+=======+=========+========+========+
     | Attribute   | Multi | Req | Case  | Mutable | Return | Unique |
     |             | Value |     | Exact |         |        |        |
     +=============+=======+=====+=======+=========+========+========+
     | displayName | F     | F   | F     | RW      | Def    | None   |
     +-------------+-------+-----+-------+---------+--------+--------+
     | active      | F     | T   | F     | RW      | Def    | None   |
     +-------------+-------+-----+-------+---------+--------+--------+
     | mudUrl      | F     | F   | T     | RW      | Def    | None   |
     +-------------+-------+-----+-------+---------+--------+--------+
     | groups      | T     | F   | T     | RO      | Def    | n/a    |
     +-------------+-------+-----+-------+---------+--------+--------+

            Table 1: Characteristics of Device Schema Attributes

   Legend:  Req = Required, T = True, F = False, RO = ReadOnly,
            RW = ReadWrite, Def = Default

   Example:

   <CODE BEGINS>
   {
           "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Device"],
           "id": "e9e30dba-f08f-4109-8486-d5c6a3316111",
           "displayName": "BLE Heart Monitor",
           "active": true,
           "meta": {
             "resourceType": "Device",
         "created": "2022-01-23T04:56:22Z",
             "lastModified": "2022-05-13T04:42:34Z",
             "version": "W\/\"a330bc54f0671c9\"",
             "location": "https://example.com/v2/Devices/e9e30dba-f08f-\
                                                 4109-8486-d5c6a3316111"
           }
   }
   <CODE ENDS>

                   Figure 3: Core Device Example Entries
Last updated on