UserSpec

pydantic model mobu.models.user.UserSpec

Configuration to generate a set of users.

Parameters:

data (Any)

Show JSON schema

{
   "title": "UserSpec",
   "description": "Configuration to generate a set of users.",
   "type": "object",
   "properties": {
      "username_prefix": {
         "description": "Each user will be formed by appending a number to this",
         "examples": [
            "bot-mobu-lsptestuser"
         ],
         "title": "Prefix for usernames",
         "type": "string"
      },
      "uid_start": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Users will be given consecutive UIDs starting with this. If omitted, Gafaelfawr will assign UIDs. (Gafaelfawr UID assignment requires Firestore be configured.)",
         "examples": [
            60000
         ],
         "title": "Starting UID"
      },
      "gid_start": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Users will be given consecutive primary GIDs starting with this. If omitted but UIDs were given, the GIDs will be equal to the UIDs. If both are omitted, Gafaelfawr will assign UIDs and GIDs (which requires Firestore and synthetic user private groups to be configured).",
         "examples": [
            60000
         ],
         "title": "Starting GID"
      },
      "groups": {
         "default": [],
         "description": "Groups of which each user is a member",
         "items": {
            "$ref": "#/$defs/Group"
         },
         "title": "Groups",
         "type": "array"
      }
   },
   "$defs": {
      "Group": {
         "description": "Configuration for the group memberships of a user.",
         "properties": {
            "name": {
               "examples": [
                  "g_special_users"
               ],
               "minLength": 1,
               "pattern": "^g_",
               "title": "Name of the group",
               "type": "string"
            },
            "id": {
               "examples": [
                  123181
               ],
               "title": "Numeric GID of the group",
               "type": "integer"
            }
         },
         "required": [
            "name",
            "id"
         ],
         "title": "Group",
         "type": "object"
      }
   },
   "required": [
      "username_prefix"
   ]
}

Fields:

• gid_start (int | None)

• groups (list[mobu.models.user.Group])

• uid_start (int | None)

• username_prefix (str)

field gid_start: int | None = None

Users will be given consecutive primary GIDs starting with this. If omitted but UIDs were given, the GIDs will be equal to the UIDs. If both are omitted, Gafaelfawr will assign UIDs and GIDs (which requires Firestore and synthetic user private groups to be configured).

field groups: list[Group] = []

Groups of which each user is a member

field uid_start: int | None = None

Users will be given consecutive UIDs starting with this. If omitted, Gafaelfawr will assign UIDs. (Gafaelfawr UID assignment requires Firestore be configured.)

field username_prefix: str [Required]

Each user will be formed by appending a number to this