Lexicon Garden

ai.newnal.illi.device.requestOnboardingCode

Register the device (device id, model) under parent 1's device-app session and issue a one-time onboarding code shown on the device.

Repository @illi-service.newnal.id did:plc:uztm7bi2ce42dez3uu3qafro namespace authority
Details · procedure
Kindprocedure
Authoritydevice.illi.newnal.ai
Indexed
Compare Edit in builder → Fork →
cid bafyreialh4avmg5dffgsw3fdvmqncbtas5vcbri5x6gwwi3ncgvl3fja7i

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.attestationNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.codeNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.deviceIdNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Register the device (device id, model) under parent 1's device-app session and issue a one-time onboarding code shown on the device.",
      "errors": [
        {
          "name": "DeviceAlreadyLinked"
        },
        {
          "name": "InvalidAttestation"
        },
        {
          "name": "DeviceRevoked"
        },
        {
          "name": "RateLimitExceeded"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "attestation": {
              "type": "string"
            },
            "deviceId": {
              "maxLength": 64,
              "type": "string"
            },
            "firmwareVersion": {
              "description": "Version of the ILLI unit's OS image (the firmware build), reported by the device itself; not verified. Trusted software state comes from the key attestation.",
              "maxLength": 32,
              "type": "string"
            },
            "model": {
              "maxLength": 64,
              "type": "string"
            },
            "timezone": {
              "description": "The device's IANA time zone (Asia/Seoul). device.link copies it to the home, and the home's daily works, upload counts and recommendations follow it. Absent or unknown to the server: Asia/Seoul.",
              "maxLength": 64,
              "type": "string"
            }
          },
          "required": [
            "deviceId",
            "model"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "code": {
              "type": "string"
            },
            "deviceId": {
              "type": "string"
            },
            "expiresAt": {
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "deviceId",
            "code",
            "expiresAt"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "ai.newnal.illi.device.requestOnboardingCode",
  "lexicon": 1
}