Skip to content
ulamsulamsulams docs

ulams groups

Generated from front/cli (ulams schema)

ulams groups create

Section titled “ulams groups create”

Create group.

Kind: write. Stability: stable. MCP tool: groups_create. Scopes: users:write.

Endpoints: POST /api/admin/user-groups/.

Flag Type Required Description
--id integer
--name string
--parent-id integer
--registerable boolean
--users array
Terminal window
# Create group
ulams groups create --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "name": {
      "type": "string"
    },
    "parent_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "registerable": {
      "type": "boolean"
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "additionalProperties": {}
}

ulams groups delete

Section titled “ulams groups delete”

Delete group.

Kind: destructive (idempotent). Stability: stable. MCP tool: groups_delete. Scopes: users:write.

Endpoints: DELETE /api/admin/user-groups/{id}.

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Delete group
ulams groups delete 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams groups get

Section titled “ulams groups get”

Get group details.

Kind: read (idempotent). Stability: stable. MCP tool: groups_get. Scopes: users:read.

Endpoints: GET /api/admin/user-groups/{id}.

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Get group details
ulams groups get 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams groups list

Section titled “ulams groups list”

List groups.

Kind: read (idempotent). Stability: stable. MCP tool: groups_list. Scopes: users:read.

Endpoints: GET /api/admin/user-groups/.

Flag Type Required Description
--page integer
--per-page integer
--search string
--parent-id integer
--user-id integer
Terminal window
# List groups
ulams groups list --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "per_page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "search": {
      "type": "string"
    },
    "parent_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": {}
}

ulams groups members

Section titled “ulams groups members”

Add user to group.

Kind: write. Stability: stable. MCP tool: groups_members. Scopes: users:write.

Endpoints: POST /api/admin/user-groups/{id}/members.

Flag Type Required Description
--id (positional) string yes
--body unknown Request body (JSON)
Terminal window
# Add user to group
ulams groups members text --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": [
        "string",
        "number"
      ]
    },
    "body": {
      "description": "Request body (JSON)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams groups members-delete

Section titled “ulams groups members-delete”

Add user to group.

Kind: destructive (idempotent). Stability: stable. MCP tool: groups_members_delete. Scopes: users:write.

Endpoints: DELETE /api/admin/user-groups/{id}/members/{user_id}.

Flag Type Required Description
--id (positional) integer yes
--user-id (positional) integer yes
Terminal window
# Add user to group
ulams groups members-delete 1 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "id",
    "user_id"
  ],
  "additionalProperties": {}
}

ulams groups tree

Section titled “ulams groups tree”

List groups in a tree.

Kind: read (idempotent). Stability: stable. MCP tool: groups_tree. Scopes: users:read.

Endpoints: GET /api/admin/user-groups/tree/.

Flag Type Required Description
--page integer
--per-page integer
--search string
--parent-id integer
Terminal window
# List groups in a tree
ulams groups tree --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "per_page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "search": {
      "type": "string"
    },
    "parent_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "additionalProperties": {}
}

ulams groups update

Section titled “ulams groups update”

Update group.

Kind: write (idempotent). Stability: stable. MCP tool: groups_update. Scopes: users:write.

Endpoints: PUT /api/admin/user-groups/{id}.

Flag Type Required Description
--id (positional) integer yes
--name string
--parent-id integer
--registerable boolean
--users array
Terminal window
# Update group
ulams groups update 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "name": {
      "type": "string"
    },
    "parent_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "registerable": {
      "type": "boolean"
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams groups users

Section titled “ulams groups users”

List of groups with users.

Kind: read (idempotent). Stability: stable. MCP tool: groups_users. Scopes: users:read.

Endpoints: GET /api/admin/user-groups/users.

Flag Type Required Description
--page integer
--per-page integer
--search string
--parent-id integer
--user-id integer
--id[] array
Terminal window
# List of groups with users
ulams groups users --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "per_page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "search": {
      "type": "string"
    },
    "parent_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "id[]": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      }
    }
  },
  "additionalProperties": {}
}