JUjumpcloud
Policytemplates
Policies

Lists all of the Policy Templates

This endpoint returns all policy templates.

Sample Request

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

Request

Query parameters

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.

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.

deliveryTypesstring[]

The supported delivery mechanisms for this policy template.

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'
statestring

String describing the release status of the policy template.

alertstring nullable

Text to describe any risk associated with this policy.

referencestring nullable

URL to visit for further information.

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.