Skip to content

Retrieve the capabilities for a device

Request

Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.devices.read

Retrieves the capabilities for a device and the readiness of each: platformSso, deviceBoundSso, sensorMode, and desktopMfaRecoveryPin.

Only macOS and Windows devices are supported. A device on any other platform, or one whose platform is missing or unrecognized, returns {"capabilities": []} with no capability lookups performed. Windows has no Platform SSO, so platformSso is always omitted for Windows devices.

An entry is omitted entirely, rather than reported as NOT_READY, when the org's plan doesn't include that capability.

  • deviceBoundSso requires the Device-Bound SSO
  • desktopMfaRecoveryPin requires Desktop MFA recovery
  • platformSso requires Desktop Password Sync

If your org's plan doesn't include one of these, the request still succeeds, but the response omits that capability's entry entirely rather than reporting it as NOT_READY with a reason code.

Path
deviceIdstringrequired

id of the device

Example:guo4a5u7JHHhjXrMK0g4
curl -i -X GET \
  https://subdomain.okta.com/api/v1/devices/guo4a5u7JHHhjXrMK0g4/capabilities

Responses

Success

Bodyapplication/json
capabilitiesArray of objects(DeviceCapability)required

One entry per capability. An entry is omitted entirely if your org's plan doesn't include that capability, or if the device's platform doesn't support it.

Response
{ "capabilities": [ { … }, { … }, { … }, { … } ] }