Devices

Generated devices operations.

GET/v1/devicesList this account's devicesadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_devices

Parameters

Name	In	Type	Description
`installationId`	query	`string`

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "app": "string",
      "appVersion": "string",
      "authority": "string",
      "current": true,
      "firstSeen": "string",
      "id": "id_8h2k4q",
      "installationId": "id_8h2k4q",
      "ip": "string",
      "lastProfileId": "id_8h2k4q",
      "lastSeen": "string",
      "name": "Fargo",
      "platform": "string",
      "rememberAccount": true,
      "sessions": 0
    }
  ]
}

Schema

itemsarray of objectrequired
- appstringrequired
- appVersionstringrequired
- authoritystringrequired
- currentbooleanrequired
- firstSeenstringrequired
- idstringrequired
- installationIdstringrequired
- ipstringrequired
- lastProfileIdstring
- lastSeenstringrequired
- namestringrequired
- platformstringrequired
- rememberAccountbooleanrequired
- sessionsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/devices" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/devicesRegister or refresh this account's devicesession

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

Request body application/json · required

Example

{
  "app": "string",
  "appVersion": "string",
  "installationId": "id_8h2k4q",
  "name": "Fargo",
  "platform": "string"
}

Schema

appstringrequired
appVersionstringrequired
installationIdstringrequired
namestringrequired
platformstringrequired

Responses

201Successapplication/json

Example

{
  "app": "string",
  "appVersion": "string",
  "authority": "string",
  "current": true,
  "firstSeen": "string",
  "id": "id_8h2k4q",
  "installationId": "id_8h2k4q",
  "ip": "string",
  "lastProfileId": "id_8h2k4q",
  "lastSeen": "string",
  "name": "Fargo",
  "platform": "string",
  "rememberAccount": true,
  "sessions": 0
}

Schema

appstringrequired
appVersionstringrequired
authoritystringrequired
currentbooleanrequired
firstSeenstringrequired
idstringrequired
installationIdstringrequired
ipstringrequired
lastProfileIdstring
lastSeenstringrequired
namestringrequired
platformstringrequired
rememberAccountbooleanrequired
sessionsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/devices" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"app":"string","appVersion":"string","installationId":"id_8h2k4q","name":"Fargo","platform":"string"}'

DELETE/v1/devices/{id}Forget a device and sign out its sessionsadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: delete_device

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestnot_foundinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/devices/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/devices/{id}Edit this account's device recordadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: patch_device
Max body: 4 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "lastProfileId": "id_8h2k4q",
  "name": "Fargo",
  "rememberAccount": true
}

Schema

lastProfileIdstring
namestring
rememberAccountboolean

Responses

200Successapplication/json

Example

{
  "app": "string",
  "appVersion": "string",
  "authority": "string",
  "current": true,
  "firstSeen": "string",
  "id": "id_8h2k4q",
  "installationId": "id_8h2k4q",
  "ip": "string",
  "lastProfileId": "id_8h2k4q",
  "lastSeen": "string",
  "name": "Fargo",
  "platform": "string",
  "rememberAccount": true,
  "sessions": 0
}

Schema

appstringrequired
appVersionstringrequired
authoritystringrequired
currentbooleanrequired
firstSeenstringrequired
idstringrequired
installationIdstringrequired
ipstringrequired
lastProfileIdstring
lastSeenstringrequired
namestringrequired
platformstringrequired
rememberAccountbooleanrequired
sessionsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestnot_foundinternaldatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/devices/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lastProfileId":"id_8h2k4q","name":"Fargo","rememberAccount":true}'

DELETE/v1/devices/{id}/sessionsSign out every session on this deviceadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: delete_device_sessions

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestnot_foundinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/devices/{id}/sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/devices/{id}/sessions/bindVerify a session's existing device bindingsession

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

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "installationId": "id_8h2k4q",
  "sessionFamilyId": "id_8h2k4q"
}

Schema

installationIdstringrequired
sessionFamilyIdstringrequired

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizedinvalid_requestnot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/devices/{id}/sessions/bind" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"installationId":"id_8h2k4q","sessionFamilyId":"id_8h2k4q"}'