ulams access

Generated from front/cli (ulams schema)

`ulams access enquiries-approve`

Approve the specified Course Access Enquiry.

Kind: write. Stability: stable. MCP tool: access_enquiries_approve. Scopes: enrolments:write.

Endpoints: POST /api/admin/course-access-enquiries/approve/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	ID
`--body`	unknown		Request body (JSON)

# Approve the specified Course Access Enquiry
ulams access enquiries-approve 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "ID"
    },
    "body": {
      "description": "Request body (JSON)"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams access enquiries-delete`

Remove the specified Course Access Enquiry.

Kind: destructive (idempotent). Stability: stable. MCP tool: access_enquiries_delete. Scopes: enrolments:write.

Endpoints: DELETE /api/admin/course-access-enquiries/{id}.

Flag	Type	Required	Description
`--id` (positional)	integer	yes	ID

# Remove the specified Course Access Enquiry
ulams access enquiries-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,
      "description": "ID"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

`ulams access enquiries-list`

Get all course access enquiries.

Kind: read (idempotent). Stability: stable. MCP tool: access_enquiries_list. Scopes: enrolments:read.

Endpoints: GET /api/admin/course-access-enquiries.

Flag	Type	Required	Description
`--page`	integer
`--limit`	integer
`--course-id`	number
`--user-id`	number
`--status`	string
`--order`	string
`--order-by`	string

# Get all course access enquiries
ulams access enquiries-list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "course_id": {
      "type": "number"
    },
    "user_id": {
      "type": "number"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "approved"
      ]
    },
    "order": {
      "type": "string"
    },
    "order_by": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}

`ulams access grant`

Give users or groups access to a course (enrol).

Course ids come from courses list, user ids from users list, group ids from groups list.

Kind: write (idempotent). Stability: stable. MCP tool: access_grant. Scopes: enrolments:write.

Endpoints: POST /api/admin/courses/{id}/access/add.

Flag	Type	Required	Description
`--course`	integer	yes	Course id.
`--user`	array		User id (repeatable).
`--group`	array		Group id (repeatable).

# Give users or groups access to a course (enrol)
ulams access grant --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"
  ]
}

`ulams access list`

List the users and groups with access to a course.

Kind: read (idempotent). Stability: stable. MCP tool: access_list. Scopes: enrolments:read.

Endpoints: GET /api/admin/courses/{id}/access.

Flag	Type	Required	Description
`--course`	integer	yes	Course id.

# Who can take course 12
ulams access list --course 12 --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."
    }
  },
  "required": [
    "course"
  ]
}

`ulams access revoke`

Remove users or groups from a course.

Course ids come from courses list, user ids from users list, group ids from groups list.

Kind: write (idempotent). Stability: stable. MCP tool: access_revoke. Scopes: enrolments:write.

Endpoints: POST /api/admin/courses/{id}/access/remove.

Flag	Type	Required	Description
`--course`	integer	yes	Course id.
`--user`	array		User id (repeatable).
`--group`	array		Group id (repeatable).

# Remove users or groups from a course
ulams access revoke --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"
  ]
}

`ulams access set`

Replace the access list of a course.

REPLACES the whole list of users and groups with access to the course; everyone not listed loses access.

Kind: destructive (idempotent). Stability: stable. MCP tool: access_set. Scopes: enrolments:write.

Endpoints: POST /api/admin/courses/{id}/access/set.

Flag	Type	Required	Description
`--course`	integer	yes	Course id.
`--user`	array		User id (repeatable).
`--group`	array		Group id (repeatable).

# Replace the access list of a course
ulams access set --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"
  ]
}