generateDeviceAuthorizationCode

v1.0.0

Get a generated device authorization code.

This is the first step in the process of authorizing a device by pin code. The device will make a request to this endpoint providing a unique identifier for the device such as a serial number. This endpoint will then return a generated code which is tied to the given device.

The code may subsequently be used to authorize the device to sign in to an account via the /account/devices/authorization endpoint. Typically this will be from a page presented in the web app under the account section.

Once authorized, the device will then be able to sign in to that account via the /authorization/device endpoint, without needing to provide the credentials of the user.

Input

{
  "type": "object",
  "properties": {
    "ff": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "idp",
          "ldp",
          "hb",
          "rpt",
          "cas",
          "lrl",
          "cd"
        ]
      }
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for this device e.g. serial number."
    },
    "lang": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "A human recognisable name for this device."
    },
    "type": {
      "type": "string",
      "description": "The device type e.g. web_browser."
    }
  },
  "required": [
    "id",
    "name",
    "type"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "The generated device authorization code."
    }
  },
  "additionalProperties": false
}