Poll a device-pairing attempt by `deviceId`. While the user has not acted, returns `pending`. On approval, returns `session` together with the granted provider session. Terminal negative states are `denied`, `expired`, and `consumed`. An unknown `deviceId` is `unknown`.
Parameters
Output
application/jsonsession
unknown
Optional
The granted provider session; present only when `status` is `session`.
status
string
Required
No description available.
Errors
InvalidRequest
The `deviceId` parameter is missing. NotFound
No pairing attempt exists for this `deviceId`. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "InvalidRequest",
"description": "The `deviceId` parameter is missing."
},
{
"name": "NotFound",
"description": "No pairing attempt exists for this `deviceId`."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"unknown",
"pending",
"denied",
"expired",
"consumed",
"session"
],
"type": "string"
},
"session": {
"type": "unknown",
"description": "The granted provider session; present only when `status` is `session`."
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"deviceId"
],
"properties": {
"deviceId": {
"type": "string"
}
}
},
"description": "Poll a device-pairing attempt by `deviceId`. While the user has not acted, returns `pending`. On approval, returns `session` together with the granted provider session. Terminal negative states are `denied`, `expired`, and `consumed`. An unknown `deviceId` is `unknown`."
}