UserGroup

pydantic model controller.models.domain.gafaelfawr.UserGroup

Gafaelfawr’s representation of a single group.

Parameters:

data (Any)

Show JSON schema
{
   "title": "UserGroup",
   "description": "Gafaelfawr's representation of a single group.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Should follow Unix naming conventions",
         "examples": [
            "ferrymen"
         ],
         "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$",
         "title": "Group to which lab user belongs",
         "type": "string"
      },
      "id": {
         "description": "32-bit unsigned integer",
         "examples": [
            2023
         ],
         "title": "Numeric GID of the group (POSIX)",
         "type": "integer"
      }
   },
   "required": [
      "name",
      "id"
   ]
}

Fields:
field id: Annotated[int, Field(examples=[2023], title='Numeric GID of the group (POSIX)', description='32-bit unsigned integer')] [Required]

32-bit unsigned integer

field name: Annotated[str, Field(examples=['ferrymen'], title='Group to which lab user belongs', description='Should follow Unix naming conventions', pattern=GROUPNAME_REGEX)] [Required]

Should follow Unix naming conventions

Constraints:
  • pattern = ^[a-zA-Z][a-zA-Z0-9._-]*$