action rudder_group_details { label: "Get group details" description: "Get detailed information about a group" provider: rudder method: GET path: "/groups/{groupId}" encoding: json output: { type: "object" required: ["action", "data", "result"] properties: { action: { type: "string" description: "The id of the action" enum: ["groupDetails"] } data: { type: "object" required: ["groups"] properties: { groups: { type: "array" items: { type: "object" properties: { description: { type: "string" description: "Group description" } displayName: { type: "string" description: "Name of the group" } dynamic: { type: "boolean" description: "Should the group be dynamically refreshed (if not, it is a static group)" } enabled: { type: "boolean" description: "Enable or disable the group" } groupClass: { type: "array" items: { type: "string" format: "condition" description: "Conditions defined on nodes in the groups. There is one based on the group id, and one based on the group name." } } id: { type: "string" format: "uuid" description: "Group id" } nodeIds: { type: "array" description: "List of nodes in the group" items: { type: "string" format: "uuid (or \"root\")" description: "Node in the group" } } properties: { type: "array" description: "Group properties" items: { type: "object" required: ["name", "value"] properties: { name: { type: "string" description: "Property name" } value: { format: "string or JSON" description: "Property value (can be a string or JSON object)" type: "object" } } } } query: { type: "object" description: "The criteria defining the group" properties: { composition: { type: "string" description: "Boolean operator to use between each `where` criteria." enum: ["and", "or"] } select: { type: "string" description: "What kind of data we want to include. Here we can get policy servers/relay by setting `nodeAndPolicyServer`. Only used if `where` is defined." } where: { type: "array" description: "List of criteria" items: { type: "object" properties: { attribute: { type: "string" description: "Attribute to compare" } comparator: { type: "string" description: "Comparator to use" } objectType: { type: "string" description: "Type of the object" } value: { type: "string" description: "Value to compare against" } } } } } } } } } } } result: { type: "string" description: "Result of the request" enum: ["success", "error"] } } } }