Quick Connect

Generated quick connect operations.

POST/v1/quick-connectRun quick connectsession

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: post_quick_connect
Max body: 64 KiB

Request body application/json · required

Example

{
  "appVersion": "string",
  "deviceName": "Fargo",
  "platform": "string",
  "requestId": "id_8h2k4q"
}

Schema

appVersionstringrequired
deviceNamestringrequired
platformstringrequired
requestIdstringrequired

Responses

201Successapplication/json

Example

{
  "deviceCode": "string",
  "expiresAt": "2026-10-18T19:30:00Z",
  "expiresIn": 0,
  "interval": 0,
  "userCode": "string",
  "verificationUri": "string",
  "verificationUriComplete": "string"
}

Schema

deviceCodestringrequired
expiresAtstringrequired
expiresInintegerrequired
intervalintegerrequired
userCodestringrequired
verificationUristringrequired
verificationUriCompletestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/quick-connect" \
  -H "Content-Type: application/json" \
  -d '{"appVersion":"string","deviceName":"Fargo","platform":"string","requestId":"id_8h2k4q"}'

POST/v1/quick-connect/cancelRun quick connect cancelsession

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: post_quick_connect_cancel
Max body: 64 KiB

Request body application/json · required

Example

{
  "deviceCode": "string"
}

Schema

deviceCodestringrequired

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/quick-connect/cancel" \
  -H "Content-Type: application/json" \
  -d '{"deviceCode":"string"}'

POST/v1/quick-connect/decisionRun quick connect decisionsession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_quick_connect_decision
Max body: 64 KiB

Request body application/json · required

Example

{
  "decision": "string",
  "requestId": "id_8h2k4q",
  "userCode": "string"
}

Schema

decisionstringrequired
requestIdstringrequired
userCodestringrequired

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/quick-connect/decision" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"string","requestId":"id_8h2k4q","userCode":"string"}'

POST/v1/quick-connect/reviewRun quick connect reviewsession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_quick_connect_review
Max body: 64 KiB

Request body application/json · required

Example

{
  "userCode": "string"
}

Schema

userCodestringrequired

Responses

200Successapplication/json

Example

{
  "appVersion": "string",
  "deviceName": "Fargo",
  "expiresAt": "2026-10-18T19:30:00Z",
  "platform": "string",
  "requestId": "id_8h2k4q",
  "serverName": "Fargo",
  "userCode": "string"
}

Schema

appVersionstringrequired
deviceNamestringrequired
expiresAtstringrequired
platformstringrequired
requestIdstringrequired
serverNamestringrequired
userCodestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/quick-connect/review" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userCode":"string"}'

POST/v1/quick-connect/tokenRun quick connect tokensession

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: post_quick_connect_token
Max body: 64 KiB

Request body application/json · required

Example

{
  "deviceCode": "string"
}

Schema

deviceCodestringrequired

Responses

200Successapplication/json

Example

{
  "accessToken": "string",
  "authorizationHorizon": "string",
  "deviceId": "id_8h2k4q",
  "expiresAt": "2026-10-18T19:30:00Z",
  "installationId": "id_8h2k4q",
  "refreshToken": "string",
  "serverIdentity": {
    "fingerprint": "string",
    "publicKey": "string"
  },
  "sessionFamilyId": "id_8h2k4q",
  "tokenGeneration": "string",
  "viewer": {
    "accountId": "id_8h2k4q",
    "authority": "string",
    "profileId": "id_8h2k4q",
    "role": "string",
    "serverId": "id_8h2k4q"
  }
}

Schema

accessTokenstringrequired
authorizationHorizonstringrequired
deviceIdstringrequired
expiresAtstringrequired
installationIdstringrequired
refreshTokenstring
serverIdentityobject
- fingerprintstringrequired
- publicKeystringrequired
sessionFamilyIdstringrequired
tokenGenerationstringrequired
viewerobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- rolestringrequired
- serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/quick-connect/token" \
  -H "Content-Type: application/json" \
  -d '{"deviceCode":"string"}'