Read User Group

Read a user group in Jamf Pro Classic API.

Options

Field Definition Type Required

Read By

Choose one of the following options as the user group identifier for the input field:

  • ID: Unique ID of the user group.

  • Name: Name of the user group.

Dropdown

TRUE

Input

The Group fields are dynamically generated based on the field selected in Options.

Field Definition Type Required

Group

ID

Unique ID of the group.

Number

TRUE

Name

Name of the group.

Text

TRUE

Output

Field Definition Type

User Group

ID

Unique ID of the user group.

Number

Name

Name of the group.

Text

Smart Group

Specifies whether this user group is a smart group.

True/False

Notify On Change

Specifies whether an email notification is sent when a membership change is made to the user group.

True/False

Site

Specifies which components can be viewed and managed by the user group.

Sites are components that Jamf Pro administrators can create to determine which objects (for example, computers, mobile devices, or apps) that Jamf Pro users can view and manage. See Sites.

Object

Users

Users included in the user group.

List of Objects

Smart Group Criteria

Criteria if this user group is a smart group. This smart group is created based on one or more inventory attributes included in the criteria list.

List of Objects

Related topics

Jamf Pro Classic API connector

Cards in flows

Jamf Pro Classic API documentation