Policytemplates
Policies

Get a specific Policy Template

This endpoint returns a specific policy template.

Sample Request

 curl -X GET https://console.jumpcloud.com/api/v2/policytemplates/{Policy_Template_ID}\
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/api/v2/policytemplates/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

OK

activationstring

Requirements before the policy can be activated.

behaviorstring

Specifics about the behavior of the policy.

descriptionstring

The default description for the Policy.

displayNamestring

The default display name for the Policy.

idstring

ObjectId uniquely identifying a Policy Template.

namestring

The unique name for the Policy Template.

osMetaFamily'linux' | 'darwin' | 'windows' | 'ios' | 'universal' | 'android'

Example response

{
  "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.