List the User Groups bound to a System
This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization.
Each element will contain the type, id, attributes and paths.
The attributes object is a key/value hash of compiled graph attributes for all paths followed.
The paths array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System.
See /members and /associations endpoints to manage those collections.
Sample Request
curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
Request
- Base URLhttps://console.jumpcloud.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The number of records to return at once. Limited to 100.
The offset into the records to return.
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
Headers
Organization identifier that can be obtained from console settings.
Current date header for the System Context API
Authorization header for the System Context API
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.