Get User Group

This endpoint returns the details of a User Group.

Sample Request

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

Basic Parameters

Parameter	Description
ID	ObjectID of the User Group.

Advanced Parameters

Parameter	Description
Organization ID	Organization identifier that can be obtained from console settings.

Example Output

{
    "attributes": {
        "sudo": {
            "enabled": true,
            "withoutPassword": true
        },
        "ldapGroups": [
            {
                "name": "string"
            }
        ],
        "posixGroups": [
            {
                "id": 0,
                "name": "string"
            }
        ],
        "radius": {
            "reply": [
                {
                    "name": "string",
                    "value": "string"
                }
            ]
        },
        "sambaEnabled": true
    },
    "description": "string",
    "email": "string",
    "id": "string",
    "memberQuery": {
        "queryType": "FilterQuery",
        "filters": [
            {
                "field": "string",
                "operator": "eq",
                "value": "string"
            }
        ]
    },
    "memberQueryExemptions": [
        {
            "attributes": {},
            "id": "string",
            "type": "string"
        }
    ],
    "memberSuggestionsNotify": true,
    "membershipAutomated": true,
    "name": "string",
    "suggestionCounts": {
        "add": 0,
        "remove": 0,
        "total": 0
    },
    "type": "user_group"
}

Workflow Library Example

Scan and Enforce Local Admin Jumpcloud Policy Daily

Preview this Workflow on desktop