Skip to main content

Update a trusted device policy

Update a trusted device policy. PATCH /api/openapi/v1/trusted-device-policies/{policyId}, scope admin.v1.trusted-device-policies.manage.

  • Scope: admin.v1.trusted-device-policies.manage
  • Permission: Manage trusted device policies (trusted-device-policies)
  • Permission type: Manage
  • Endpoint: PATCH/api/openapi/v1/trusted-device-policies/{policyId}

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.
NameLocationTypeRequiredDescriptionExample
AuthorizationheaderstringYesApplication API key, passed as a Bearer token.Bearer qwk_***
X-Request-IdheaderstringNoOptional request tracing identifier; generated by the server if omitted.req-20260831-001

Request parameters

NameLocationTypeRequiredDescriptionExample
policyIdpathstring · uuidRequiredPolicy group ID"<uuid>"
descriptionbodystringNoPolicy group description"<string>"
first_device_auto_trustbodybooleanRequiredAutomatically trust the first devicefalse
namebodystringRequiredPolicy name"<string>"
prioritybodyinteger | null · int64RequiredPriority1
scope_typebodystringRequiredUser scope type"all"
subjectsbodyarray | nullRequiredSelected users[{"id":"<uuid>","name":"<string>","type":"department"}]
validation_enabledbodybooleanRequiredEnable trusted device verificationfalse
versionbodyinteger · int64RequiredVersion used for concurrent update checks0

Request example

cURL

Responses

200 OK
NameTypeRequiredDescriptionExample
created_atstring | null · date-timeYesCreated at"2026-08-27T10:00:00Z"
created_bystring | null · uuidNoCreator ID"<uuid>"
created_by_emailstringNoCreator email"<string>"
created_by_namestringNoCreated by"<string>"
descriptionstringYesPolicy group description"<string>"
first_device_auto_trustbooleanYesAutomatically trust the first devicefalse
idstring · uuidYesPolicy group ID"<uuid>"
is_defaultbooleanYesWhether this is the default policy groupfalse
namestringYesPolicy name"<string>"
priorityinteger | null · int64YesPriority0
scope_typestringYesUser scope type"all"
subjectsarray<OpenapifacadeScopeSubject>YesSelected users[{"id":"<uuid>","name":"<string>","type":"department"}]
subjects[].idstring · uuidYesScope subject ID"<uuid>"
subjects[].namestringYesScope subject name"<string>"
subjects[].typestringYesObject type"department"
updated_atstring | null · date-timeYesUpdated at"2026-08-27T10:00:00Z"
updated_bystring | null · uuidNoUpdater ID"<uuid>"
updated_by_emailstringNoUpdater email"<string>"
updated_by_namestringNoUpdated by"<string>"
validation_enabledbooleanYesEnable trusted device verificationfalse
versioninteger · int64YesVersion used for concurrent update checks0
Response example
default Flat business error
NameTypeRequiredDescriptionExample
codestringNoStable business error code"<string>"
detailstringYesHuman-readable error description"<string>"
detailsOpenapiErrorDetailsNoError details{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstringNoRequest field that failed validation"<string>"
details.reasonstringNoStable validation failure reason"<string>"
details.suggestionstringNoSuggested normalized value"<string>"
errorstringYesStable HTTP error type"<string>"
Response example