AdminHistoryEntry

pydantic model gafaelfawr.models.history.AdminHistoryEntry

A record of a change to the token administrators.

Parameters:

data (Any)

Show JSON schema

{
   "title": "AdminHistoryEntry",
   "description": "A record of a change to the token administrators.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username of the token administrator that was changed",
         "examples": [
            "someadmin"
         ],
         "maxLength": 64,
         "minLength": 1,
         "title": "Username",
         "type": "string"
      },
      "action": {
         "allOf": [
            {
               "$ref": "#/$defs/AdminChange"
            }
         ],
         "examples": [
            "add"
         ],
         "title": "Type of change"
      },
      "actor": {
         "description": "Username of the person making the change",
         "maxLength": 64,
         "minLength": 1,
         "title": "Actor",
         "type": "string"
      },
      "ip_address": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "IP address from which the change was made. Will be missing if the change was made internally by Gafaelfawr.",
         "title": "IP address"
      },
      "event_time": {
         "description": "When the change was made",
         "examples": [
            1614986130
         ],
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      }
   },
   "$defs": {
      "AdminChange": {
         "description": "Type of change made to a token admin.",
         "enum": [
            "add",
            "remove"
         ],
         "title": "AdminChange",
         "type": "string"
      }
   },
   "required": [
      "username",
      "action",
      "actor"
   ]
}

Fields:

• action (gafaelfawr.models.history.AdminChange)

• actor (str)

• event_time (datetime.datetime)

• ip_address (str | None)

• username (str)

Validators:

• normalize_datetime » event_time

• normalize_ip_address » ip_address

field action: AdminChange [Required]

field actor: str [Required]

Username of the person making the change

Constraints:

• min_length = 1

• max_length = 64

field event_time: datetime [Optional]

When the change was made

Validated by:

• normalize_datetime

field ip_address: str | None = None

IP address from which the change was made. Will be missing if the change was made internally by Gafaelfawr.

Validated by:

• normalize_ip_address

field username: str [Required]

Username of the token administrator that was changed

Constraints:

• min_length = 1

• max_length = 64