Update User Group

This endpoint allows you to do a full update of the User Group.

Sample Request

curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "name": "group_update"
  }'

Basic Parameters

Parameter	Description
Description	Description of a User Group.
Email	Email address of a User Group.
ID	ObjectID of the User Group.
Member Query	Query using a sequence of field filters.
Name	Display name of a User Group.

Advanced Parameters

Parameter	Description
Attributes	The graph attributes for a UserGroup.
Attributes Ldap Groups	-
Attributes Posix Groups	-
Attributes Samba Enabled	-
Member Query Exemptions	Array of GraphObjects exempted from the query.
Member Query Filters	-
Member Query Query Type	-
Member Suggestions Notify	True if notification emails are to be sent for membership suggestions.
Membership Automated	True if membership of this group is automatically updated based on the Member Query and Member Query Exemptions, if configured.
Organization ID	Organization identifier that can be obtained from console settings.
Radius Reply	-
Sudo Enabled	Enables sudo.
Sudo Without Password	Enable sudo without password (requires 'enabled' to be true).

Example Output

{
    "attributes": {
        "ldapGroups": [
            {
                "name": "string"
            }
        ],
        "posixGroups": [
            {
                "id": 0,
                "name": "string"
            }
        ],
        "radius": {
            "reply": [
                {
                    "name": "string",
                    "value": "string"
                }
            ]
        },
        "sambaEnabled": false,
        "sudo": {
            "enabled": false,
            "withoutPassword": false
        }
    },
    "description": "Description of a User Group",
    "email": "Email address of a User Group",
    "id": "ObjectId uniquely identifying a User Group.",
    "memberQuery": {
        "filters": [
            {
                "field": "Name of field in filter target object.",
                "operator": "Filter comparison operator.",
                "value": "Filter comparison value."
            }
        ],
        "queryType": "string"
    },
    "memberQueryExemptions": [
        {
            "attributes": {},
            "id": "The ObjectID of the graph object.",
            "type": "The type of graph object."
        }
    ],
    "memberSuggestionsNotify": false,
    "membershipAutomated": false,
    "name": "Display name of a User Group.",
    "suggestionCounts": {
        "add": 0,
        "remove": 0,
        "total": 0
    },
    "type": "The type of the group."
}

Workflow Library Example

Scan and Enforce Local Admin Jumpcloud Policy Daily

Preview this Workflow on desktop