Change Static Group Membership

This tool will add or remove the computer it is run on from a specific Static Group, based on the name of the group.

Command Options

Required Parameters

--staticGroupName [string]

Specifies the name of a static group from which the user will be added or removed.

• Type: string
• Example:

  --staticGroupName "Temporary Admin Privileges"

--clientId [string]

Specifies the encrypted credentials for Jamf API authentication.

• Type: string
• Permissions: Create a New API Role with the following permissions:
  • Update Static Computer Groups
  • Read Static Computer Groups
  • Create Computers
• Example:

  --clientId "..." OR --clientId "ENC:..."

--clientSecret [string]

Specifies the encrypted credentials for Jamf API authentication.

• Type: string
• Permissions: Create a New API Role with the following permissions:
  • Update Static Computer Groups
  • Read Static Computer Groups
  • Create Computers
• Example:

  --clientSecret "..." OR --clientSecret "ENC:..."

Optional Parameters

--action [add|remove]

Defines the action for the tool, either to add to add computer to static group or remove to remove computer from static group.

• Type: string
• Choices: add, remove
• Default: add
• Example:

  --action add

--domain [string]

Specifies the domain for setting options in local or managed plists.

• Type: string
• Default: tech.rocketman.changestaticgroupmembership
• Example:

  --domain "tech.rocketman.customdomain"

JSON Scheme

{
  "title": "Change Static Group Membership (tech.rocketman.changestaticgroupmembership)",
  "description": "This tool will add or remove the computer it is run on from a specific Static Group, based on the name of the group",
  "properties": {
    "staticGroupName": {
      "title": "Static Group Name",
      "description": "Name of the static group from which the user will be added or removed.",
      "type": "string",
      "property_order": 1
    },
    "clientId": {
      "title": "Client ID",
      "description": "Specifies the Client ID for Jamf API authentication. Permissions needed: Update Static Computer Groups, Read Static Groups, Create Computers. It is recommended to Encrypt these credentials using RCC's Encrypt tool.",
      "type": "string",
      "property_order": 2
    },
    "clientSecret": {
      "title": "Client Secret",
      "description": "Specifies the Client ID for Jamf API authentication. Permissions needed: Update Static Computer Groups, Read Static Groups, Create Computers. It is highly recommended to Encrypt these credentials using RCC's Encrypt tool.",
      "type": "string",
      "property_order": 3
    },
    "action": {
      "title": "Action",
      "description": "Defines whether to add or remove a computer from the static group.",
      "type": "string",
      "enum": [
        "add",
        "remove"
      ],
      "default": "add",
      "property_order": 4
    }
  },
  "required": [
    "staticGroupName",
    "clientId",
    "clientSecret"
  ]
}