ulams csv

ulams csv groups

Imports group from csv.

Kind: write. Stability: stable. MCP tool: csv_groups. Scopes: courses:write.

Endpoints: POST /api/admin/csv/groups.

Flag	Type	Required	Description
--file	string		file (path of a local file)
--return-url	string		Address where the new user set the password

# Imports group from csv
ulams csv groups --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "file (path of a local file)"
    },
    "return_url": {
      "type": "string",
      "description": "Address where the new user set the password"
    }
  },
  "additionalProperties": {}
}

ulams csv groups-group-id

Exports users to csv.

Kind: read (idempotent). Stability: stable. MCP tool: csv_groups_group_id. Scopes: courses:read.

Endpoints: GET /api/admin/csv/groups/group_id.

Flag	Type	Required	Description
--format	string		exported file format
--out	string		Write the download to this path (- for stdout)

# Exports users to csv
ulams csv groups-group-id --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "exported file format"
    },
    "out": {
      "description": "Write the download to this path (- for stdout)",
      "type": "string"
    }
  },
  "additionalProperties": {}
}

ulams csv users-add

Imports users from csv.

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

Endpoints: POST /api/admin/csv/users.

Flag	Type	Required	Description
--file	string		file (path of a local file)
--return-url	string		Address where the new user set the password

# Imports users from csv
ulams csv users-add --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "file (path of a local file)"
    },
    "return_url": {
      "type": "string",
      "description": "Address where the new user set the password"
    }
  },
  "additionalProperties": {}
}

ulams csv users-list

Exports users to csv.

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

Endpoints: GET /api/admin/csv/users.

Flag	Type	Required	Description
--search	string		will search through first_name, last_name and email
--role	string		user role
--format	string		exported file format
--status	boolean		will check if user is_active
--onboarding	boolean		will check if user completed onboarding
--from	string		users created after this date
--to	string		users created before this date
--out	string		Write the download to this path (- for stdout)

# Exports users to csv
ulams csv users-list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "search": {
      "type": "string",
      "description": "will search through first_name, last_name and email"
    },
    "role": {
      "type": "string",
      "description": "user role"
    },
    "format": {
      "type": "string",
      "description": "exported file format"
    },
    "status": {
      "type": "boolean",
      "description": "will check if user is_active"
    },
    "onboarding": {
      "type": "boolean",
      "description": "will check if user completed onboarding"
    },
    "from": {
      "type": "string",
      "description": "users created after this date"
    },
    "to": {
      "type": "string",
      "description": "users created before this date"
    },
    "out": {
      "description": "Write the download to this path (- for stdout)",
      "type": "string"
    }
  },
  "additionalProperties": {}
}