Activation code
OPTIONS /activationCode
Purpose
Provides CORS support information for the endpoint.
Responses
Always 200 OK with CORS response headers.
POST /activationCode
Purpose
Generate an activation code for a device.
Payload
Type
JSON in body.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
deviceId | Yes | String | Unique identifier of a device. |
deviceType | Yes | DeviceType | Type of device. |
returnUri | No | String | URI to redirect user to after activation. |
stationId | Yes | UUID | ID of the station associated with the device. |
Responses
- 200 OK
- 400 Bad Request
- 403 Forbidden
- 405 Method Not Allowed
JSON body with four properties:
activationUrl: Device activation URL.code: Unique six digit code associated with the provided deviceId.displayUrl: Station-provided device activation URL redirect with scheme removed.otpActivationUrl: API endpoint URL to kick off OAuth and redirect user to device activation screen, skipping code entry page.qrCodeUrl: URL to generate a QR code for a viewer to scan and access the activation form in a browser.
JSON body with one property:
reason: Code string indicating the reason for the error:ALREADY_REGISTERED: ProvideddeviceIdis already registered to a viewer.MISSING_PARAMETERS: Required payload parameters are missing.NO_UNIQUE_CODE: The function was unable to generate a unique activation codeSTATION_NOT_FOUND: ProvidedstationIdnot found.UNKNOWN_DEVICE_TYPE: ProvideddeviceTypenot valid.
Indicates an invalid Origin header was passed in a CORS request.
Returned for any unsupported HTTP method.
POST /activationCode/startOAuth
Purpose
Initiate an OAuth flow for a device activation.
Payload
Type
JSON in body.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
code | Yes | String | Code associated with a known device. |
stationCallSign | Yes | String | Station call sign associated with the device. |
Responses
- 200 OK
- 400 Bad Request
- 403 Forbidden
- 404 Not Found
- 405 Method Not Allowed
JSON body with one property:
state: State value to be included with the OAuth flow. See The OAuth 2.0 Authorization Framework for details about how to use this value.
JSON body with one property:
reason: Code string indicating the reason for the error:BAD_PAYLOAD: MalformedPOSTbody of missing required parameter.
Indicates an invalid Origin header was passed in a CORS request.
Indicates the device could not be found with the provided code parameter.
Returned for any unsupported HTTP method.
GET /activationCode/otp
Purpose
Initiate the OAuth flow for a device activation and redirect to the device login page, bypassing the code entry page, to complete activation.
Payload
Type
Search parameters.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
code | Yes | String | Code associated with a known device. |
stationCallSign | Yes | String | Station call sign associated with the device. |
Responses
- 302 Found
- 400 Bad Request
- 404 Not Found
- 405 Method Not Allowed
Redirect to the device login page.
JSON body with:
reason: Code string indicating the reason for the error:BAD_PAYLOAD: Missing required fields or invlaid OAuth2 state value.DEVICE_NOT_FOUND: Device not found with state data.STATION_NOT_FOUND: Unknown station call sign.
Indicates the device could not be found with the provided code parameter.
Returned for any unsupported HTTP method.