Policies

Update an existing Policy

This endpoint allows you to update a policy. Given the amount of configurable parameters required to update a Policy, we suggest you use the JumpCloud Admin Console to create new policies.

Sample Request
curl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    {Policy_Parameters}
  }'
put/policies/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

namestring required

The description for this specific Policy.

notesstring

The notes for this specific Policy.

Response

OK

idstring

ObjectId uniquely identifying a Policy.

namestring

The description for this specific Policy.

Example response

{
  "template": {
    "osRestrictions": [
      {
        "with-apple-restrictions": {
          "osName": "iPadOS",
          "earliestVersion": "14.1",
          "deprecatedVersion": "16.2",
          "appleRestrictions": {
            "requiresSupervision": false,
            "supportedEnrollmentTypes": [
              "automated",
              "device",
              "user"
            ]
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.