ulams roles

ulams roles create

Find or Create a Role.

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

Endpoints: POST /api/admin/roles.

Flag	Type	Required	Description
--guard-name	string		Guard Name
--id	integer		id
--name	string	yes	name

# Find or Create a Role
ulams roles create --name Example --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "guard_name": {
      "type": "string",
      "description": "Guard Name"
    },
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id"
    },
    "name": {
      "type": "string",
      "description": "name"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": {}
}

ulams roles delete

Delete a Role identified by a name.

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

Endpoints: DELETE /api/admin/roles/{name}.

Flag	Type	Required	Description
--name (positional)	integer	yes	Unique human-readable role identifier

# Delete a Role identified by a name
ulams roles delete 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Unique human-readable role identifier"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": {}
}

ulams roles get

Read a role and returns list of all permissions.

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

Endpoints: GET /api/admin/roles/{name}.

Flag	Type	Required	Description
--name (positional)	string	yes	Unique human-readable template identifier

# Read a role and returns list of all permissions
ulams roles get Example --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Unique human-readable template identifier"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": {}
}

ulams roles list

Lists available roles.

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

Endpoints: GET /api/admin/roles.

# Lists available roles
ulams roles list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}

ulams roles update

Update an existing Role identified by name by list or new permissions.

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

Endpoints: PATCH /api/admin/roles/{name}.

Flag	Type	Required	Description
--name (positional)	integer	yes	Unique human-readable role identifier
--permissions	array		Permissions

# Update an existing Role identified by name by list or new permissions
ulams roles update 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Unique human-readable role identifier"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Permissions"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": {}
}