Skip to content

ulams enrol

Generated from front/cli (ulams schema)

Enrol users or groups in a course (alias of access grant).

Kind: write (idempotent). Stability: stable. MCP tool: enrol (not exposed). Scopes: enrolments:write.

Flag Type Required Description
--course integer yes Course id.
--user array User id (repeatable).
--group array Group id (repeatable).
Terminal window
# Enrol a user
ulams enrol --course 12 --user 34 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"course": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Course id."
},
"user": {
"description": "User id (repeatable).",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"group": {
"description": "Group id (repeatable).",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
}
},
"required": [
"course"
]
}