Device Schema

Schema extensions for provisioning devices, not just users.

The SCIM core schema was designed for provisioning users. RFC 9944 adds schemas for provisioning devices, and for carrying the bootstrapping material a device needs to get onto a network. It defines two new resource types plus a family of extensions, one per underlying onboarding system — Wi-Fi Easy Connect, FIDO Device Onboard vouchers, Bluetooth Low Energy pairing, MAC Authenticated Bypass, and Zigbee.

Unlike RFC 9865 and RFC 9967, this document does not update RFC 7643 or RFC 7644. It is purely additive: new resource types and new schema URIs, using the extension model the core schema already provides.

Resource types

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

A provisionable device. Carries the core attributes below, and one or more bootstrapping extensions describing how the device is onboarded.

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

An application permitted to communicate with devices. Devices reference endpoint applications through the application endpoint extension, which is how a deployment expresses which app may talk to which device.

Core device attributes

All four sit alongside the usual common attributes — id, externalId, and meta — described in the object model. A minimal Device resource:

{
  "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"
  }
}

Bootstrapping extensions

Each onboarding system gets its own extension schema, keyed by URI in the resource just like any other SCIM extension. A device lists every schema it conforms to in schemas.

Every URI above is prefixed urn:ietf:params:scim:schemas. BLE additionally defines four pairing-method extensions — pairingJustWorks, pairingPassKey, pairingOOB, and pairingNull — selected according to how the device authenticates during pairing.

A device onboarded with Wi-Fi Easy Connect carries its bootstrapping key, MAC address, and the class/channel pairs it can be reached on:

{
  "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",
  "active": true,
  "urn:ietf:params:scim:schemas:extension:dpp:2.0:Device": {
    "dppVersion": 2,
    "bootstrappingMethod": ["QR"],
    "bootstrapKey": "MDkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDIgADURzxmttZoIRIPWGoQMV00XHWCAQIhXruVWOz0NjlkIA=",
    "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\""
  }
}