UserInfo#

pydantic model nublado.controller.models.v1.lab.UserInfo#

Metadata about the user who owns the lab.

Parameters:: data (Any)

Show JSON schema

{
   "title": "UserInfo",
   "description": "Metadata about the user who owns the lab.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username of the owner of this lab",
         "examples": [
            "ribbon"
         ],
         "title": "Username",
         "type": "string"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Preferred human-readable name for the user. May contain spaces, capital letters, and non-ASCII Unicode characters. Should be the user's preferred representation of their name to other humans.",
         "examples": [
            "Ribbon"
         ],
         "title": "Display name for user"
      },
      "uid": {
         "description": "POSIX numeric UID for the user as a 32-bit unsigned integer",
         "examples": [
            1104
         ],
         "title": "Numeric UID",
         "type": "integer"
      },
      "gid": {
         "description": "POSIX numeric GID for user's primary group as a 32-bit unsigned integer",
         "examples": [
            1104
         ],
         "title": "Numeric GID of primary group",
         "type": "integer"
      },
      "groups": {
         "default": [],
         "description": "All POSIX group memberships of the user with associated GIDs, used to set the user's supplemental groups",
         "items": {
            "$ref": "#/$defs/UserGroup"
         },
         "title": "User's group memberships",
         "type": "array"
      }
   },
   "$defs": {
      "UserGroup": {
         "description": "Group membership.",
         "properties": {
            "name": {
               "description": "Should follow Unix naming conventions",
               "examples": [
                  "ferrymen"
               ],
               "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"
         ],
         "title": "UserGroup",
         "type": "object"
      }
   },
   "required": [
      "username",
      "uid",
      "gid"
   ]
}

Fields:

gid (int)
groups (list[nublado.controller.models.v1.lab.UserGroup])
name (str | None)
uid (int)
username (str)

field gid: Annotated[int, Field(title='Numeric GID of primary group', description="POSIX numeric GID for user's primary group as a 32-bit unsigned integer", examples=[1104])] [Required]#: POSIX numeric GID for user’s primary group as a 32-bit unsigned integer

field groups: Annotated[list[UserGroup], Field(title="User's group memberships", description="All POSIX group memberships of the user with associated GIDs, used to set the user's supplemental groups")] = []#: All POSIX group memberships of the user with associated GIDs, used to set the user’s supplemental groups

field name: Annotated[str | None, Field(title='Display name for user', description="Preferred human-readable name for the user. May contain spaces, capital letters, and non-ASCII Unicode characters. Should be the user's preferred representation of their name to other humans.", examples=['Ribbon'])] = None#: Preferred human-readable name for the user. May contain spaces, capital letters, and non-ASCII Unicode characters. Should be the user’s preferred representation of their name to other humans.

field uid: Annotated[int, Field(title='Numeric UID', description='POSIX numeric UID for the user as a 32-bit unsigned integer', examples=[1104])] [Required]#: POSIX numeric UID for the user as a 32-bit unsigned integer

field username: Annotated[str, Field(title='Username', description='Username of the owner of this lab', examples=['ribbon'])] [Required]#: Username of the owner of this lab