Desktop Policies

Update desktop policy

Changed on

Rewrites one desktop policy. The full write body is required: the policy document is replaced (access, execution, and onboarding prompts omitted from it are carried over from the stored document) and the member, team, and role assignments are replaced with the ones sent. The default policy keeps its name, priority, and assignments and cannot be disabled (400 default_policy_required).

patch/v1/desktop-policies/{desktopPolicyId}

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/desktop-policies/{desktopPolicyId}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

desktopPolicyIdstring typeid required

Den TypeID with 'dpo_' prefix and a 26-character base32 suffix.

Request body

policyNamestring required
priorityinteger
isEnabledboolean
memberIdsstring[]
teamIdsstring[]
rolesstring[]

Response

Desktop policy updated successfully.

desktopPolicyobject required

Changes

  • df3754993784Revision changes
    • info

      added the optional property to the response with the status

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API