JUjumpcloud
Policy Groups

List all Policy Groups

This endpoint returns all Policy Groups.

Available filter fields:

  • name
  • type

Sample Request

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

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

attributesGraphAttributes nullable

The graph attributes.

descriptionstring

Description of a Policy Group

emailstring

E-mail address associated with a Policy Group

idstring

ObjectId uniquely identifying a Policy Group.

namestring

Display name of a Policy Group.

organizationObjectIdstring nullable

id of the organization owning this group

type'policy_group'

The type of the group; always 'policy' for a Policy Group.

Changes

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