JUjumpcloud
Groups

List All Groups

This endpoint returns all Groups that exist in your organization.

Available filter fields:

  • name
  • type
  • memberQueryErrorFlags

Sample Request

  curl -X GET \
  https://console.jumpcloud.com/api/v2/groups \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/groups

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.

x-unfiltered-total-countinteger

If provided in the request with any non-empty value, this header will be returned on the response populated with the total count of objects without filters taken into account

Response

OK

attributesGraphAttributes nullable

The graph attributes.

descriptionstring

Description of a Group

emailstring

E-mail address associated with a Group

idstring

ObjectId uniquely identifying a Group.

namestring

Display name of a Group.

organizationObjectIdstring nullable

id of the organization owning this group

type'policy_group' | 'system_group' | 'user_group'

The group type.

memberQueryErrorFlagsstring[]

Group error flags indicating errors encountered during member query evaluation.

Possible flag values:

  • CYCLE: A cyclic dependency was detected in group membership
  • INVALID_GROUP_REFERENCE: The group reference is invalid or does not exist

The member_query_error_flags as a field supports array-based filtering:

  • CO: Contains Overlap - check if array overlaps with the specified array (use ["VALUE"] for single value)
  • NCO: Not Contains Overlap - check if array does not overlap
  • EQ: Exact array match
  • NE: Not equal to array
  • IN: Array contains any of the specified values Note: Single value is converted to array `["value"]``.

Changes

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