JUjumpcloud
User Groups

Update a User Group

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

See the Dynamic Group Configuration KB article for more details on maintaining a Dynamic 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"
  }'
put/usergroups/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

x-query-dsl'v1' | 'v2'

Optional header. Specifies the query DSL version for memberQuery. Allowed values: "v1", "v2". Defaults to "v1". When set to "v2", memberQuery expects the updated structured filter format without queryType.

Request body

emailstring

Email address of a User Group

descriptionstring

Description of a User Group

memberSuggestionsNotifyboolean

True if notification emails are to be sent for membership suggestions.

membershipMethod'NOTSET' | 'STATIC' | 'DYNAMIC_REVIEW_REQUIRED' | 'DYNAMIC_AUTOMATED'

The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.

Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for group-associated MDM-enrolled devices.

Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets.

namestring required

Display name of a User Group.

Response

OK

emailstring

Email address of a User Group

descriptionstring

Description of a User Group

idstring

ObjectId uniquely identifying a User Group.

memberSuggestionsNotifyboolean

True if notification emails are to be sent for membership suggestions.

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"]``.
membershipMethod'NOTSET' | 'STATIC' | 'DYNAMIC_REVIEW_REQUIRED' | 'DYNAMIC_AUTOMATED'

The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED.

Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for group-associated MDM-enrolled devices.

Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets.

namestring

Display name of a User Group.

organizationObjectIdstring nullable

id of the organization owning this group

type'user_group'

The type of the group.

Changes

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