API ReferenceAuthorization

Request device code

Headers

x-client-versionstringOptionalDefaults to 0.0.0
Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
x-client-platypus-enabledenumOptional
Enable URL Pairing mode for C2C device code requests. Set to 'true' to enable.
Allowed values:

Request

client_idstringRequired
A unique identifier for the physical hardware device. This value needs to be guaranteed to be unique for the device. This could be a serial number or a randomly generated UUID.
client_secretstringRequired
This will be issued to you by Frame.io support and identifies the your device model. This value should be kept secret from the user, and should be encrypted at rest
scopeenumRequired
The permissions we are requesting, with spaces used as delimiters. Hardware devices can only request the following two scopes
Allowed values:

Response

Successful request
device_codestring>=1 character
The device code should be hidden from the user, and is used to identify this authorization request when polling to see if the user has entered their code successfully.
expires_indouble<=120
The number of seconds until this code expires.
intervaldouble
How long the we should wait between polling requests to see if the user has entered the code.
namestring>=1 character
The name of the device we are trying to connect.
user_codestring>=1 character

The six-digit code the user will enter into Frame.io to pair the device to a project.

verification_uristringformat: "uri"
The URL where the user should go to enter the pairing code.
verification_uri_completestring or nullformat: "uri"

A complete URL with the user code pre-filled, which can be used to streamline the pairing process.