List trusted device policies. GET /api/openapi/v1/trusted-device-policies, scope admin.v1.trusted-device-policies.read.
- Scope: admin.v1.trusted-device-policies.read
- Permission: Read trusted device policies (trusted-device-policies)
- Permission type: Read
- Endpoint: GET/api/openapi/v1/trusted-device-policies
Authentication and request headers
Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| page | query | integer · int64 | No | Page number | 1 |
| page_size | query | integer · int64 | No | Page size | 20 |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| items | array<OpenapifacadeTrustedDevicePolicyResponse> | Yes | Records | [{"created_at":"2026-08-27T10:00:00Z","created_by":"<uuid>","created_by_email":"<string>","created_by_name":"<string>","description":"<string>","first_device_auto_trust":false,"id":"<uuid>","is_default":false,"name":"<string>","priority":0,"scope_type":"all","subjects":[{"id":"<uuid>","name":"<string>","type":"department"}],"updated_at":"2026-08-27T10:00:00Z","updated_by":"<uuid>","updated_by_email":"<string>","updated_by_name":"<string>","validation_enabled":false,"version":0}] |
| items[].created_at | string ｜ null · date-time | Yes | Created at | "2026-08-27T10:00:00Z" |
| items[].created_by | string ｜ null · uuid | No | Creator ID | "<uuid>" |
| items[].created_by_email | string | No | Creator email | "<string>" |
| items[].created_by_name | string | No | Created by | "<string>" |
| items[].description | string | Yes | Policy group description | "<string>" |
| items[].first_device_auto_trust | boolean | Yes | Automatically trust the first device | false |
| items[].id | string · uuid | Yes | Policy group ID | "<uuid>" |
| items[].is_default | boolean | Yes | Whether this is the default policy group | false |
| items[].name | string | Yes | Policy name | "<string>" |
| items[].priority | integer ｜ null · int64 | Yes | Priority | 0 |
| items[].scope_type | string | Yes | User scope type | "all" |
| items[].subjects | array<OpenapifacadeScopeSubject> | Yes | Selected users | [{"id":"<uuid>","name":"<string>","type":"department"}] |
| items[].subjects[].id | string · uuid | Yes | Policy group ID | "<uuid>" |
| items[].subjects[].name | string | Yes | Policy name | "<string>" |
| items[].subjects[].type | string | Yes | Object type | "department" |
| items[].updated_at | string ｜ null · date-time | Yes | Updated at | "2026-08-27T10:00:00Z" |
| items[].updated_by | string ｜ null · uuid | No | Updater ID | "<uuid>" |
| items[].updated_by_email | string | No | Updater email | "<string>" |
| items[].updated_by_name | string | No | Updated by | "<string>" |
| items[].validation_enabled | boolean | Yes | Enable trusted device verification | false |
| items[].version | integer · int64 | Yes | Version used for concurrent update checks | 0 |
| page | integer · int64 | Yes | Page number | 0 |
| page_size | integer · int64 | Yes | Page size | 0 |
| total | integer · int64 | Yes | Total count | 0 |
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |