Skip to main content

Group

Group management on target hosts.

Methods​

MethodDescription
List(ctx, hostname)List all groups
Get(ctx, hostname, name)Get a group by name
Create(ctx, hostname, opts)Create a group
Update(ctx, hostname, name, opts)Update a group
Delete(ctx, hostname, name)Delete a group

Usage​

import "github.com/retr0h/osapi/pkg/sdk/client"

c := client.New("http://localhost:8080", token)

// List all groups
resp, err := c.Group.List(ctx, "_any")
for _, r := range resp.Data.Results {
    for _, g := range r.Groups {
        fmt.Printf("%s gid=%d\n", g.Name, g.GID)
    }
}

// Get a specific group
resp, err := c.Group.Get(ctx, "web-01", "docker")

// Create a group
resp, err := c.Group.Create(ctx, "web-01", client.GroupCreateOpts{
    Name: "deploy",
})

// Update group members
resp, err := c.Group.Update(ctx, "web-01", "deploy", client.GroupUpdateOpts{
    Members: []string{"alice", "bob"},
})

// Delete a group
resp, err := c.Group.Delete(ctx, "web-01", "deploy")

Example​

See examples/sdk/client/group.go for a complete working example.

Permissions​

Requires user:read for List and Get. Create, Update, and Delete require user:write.