TokenChangeHistoryEntry

pydantic model gafaelfawr.models.history.TokenChangeHistoryEntry

A record of a change to a token.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "TokenChangeHistoryEntry",
   "description": "A record of a change to a token.",
   "type": "object",
   "properties": {
      "token": {
         "examples": [
            "dDQg_NTNS51GxeEteqnkag"
         ],
         "maxLength": 22,
         "minLength": 22,
         "title": "Token key",
         "type": "string"
      },
      "username": {
         "examples": [
            "someuser"
         ],
         "maxLength": 64,
         "minLength": 1,
         "title": "Username of the token",
         "type": "string"
      },
      "token_type": {
         "allOf": [
            {
               "$ref": "#/$defs/TokenType"
            }
         ],
         "description": "Class of token, chosen from:\n\n* `session`: An interactive user web session\n* `user`: A user-generated token that may be used programmatically\n* `notebook`: The token delegated to a Jupyter notebook for the user\n* `internal`: A service-to-service token used for internal sub-calls made as part of processing a user request\n* `service`: A service-to-service token used for internal calls initiated by services, unrelated to a user request\n",
         "examples": [
            "user"
         ],
         "title": "Type of the token"
      },
      "token_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Only set for tokens of type user. If the name was changed, this will be the new name of the token.",
         "examples": [
            "a token"
         ],
         "title": "Name of the token"
      },
      "parent": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "examples": [
            "1NOV_8aPwhCWj6rM-p1XgQ"
         ],
         "title": "Key of parent token of this token"
      },
      "scopes": {
         "examples": [
            [
               "read:all"
            ]
         ],
         "items": {
            "type": "string"
         },
         "title": "Scopes of the token",
         "type": "array"
      },
      "service": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Only set for tokens of type internal.",
         "examples": [
            "some-service"
         ],
         "title": "Service to which the token was issued"
      },
      "expires": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "If the expiration was changed, this will be the new expiration of the token.",
         "examples": [
            1615785631
         ],
         "title": "Expiration of the token"
      },
      "actor": {
         "examples": [
            "adminuser"
         ],
         "maxLength": 64,
         "minLength": 1,
         "title": "Username of person making the change",
         "type": "string"
      },
      "action": {
         "allOf": [
            {
               "$ref": "#/$defs/TokenChange"
            }
         ],
         "examples": [
            "edit"
         ],
         "title": "Type of change that was made"
      },
      "old_token_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This field will only be present for edit changes to user tokens that changed the token name.",
         "examples": [
            "old name"
         ],
         "title": "Previous name of the token"
      },
      "old_scopes": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This field will only be present for edit changes that changed the token scopes.",
         "examples": [
            [
               "read:some"
            ]
         ],
         "title": "Previous scopes of the token"
      },
      "old_expires": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This field will only be present for edit changes that changed the expiration of the token.",
         "examples": [
            1614985631
         ],
         "title": "Previous expiration of the token"
      },
      "ip_address": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "May be null if the change was made internally, such as token deletion due to expiration.",
         "examples": [
            "198.51.100.50"
         ],
         "title": "IP address from which the change was made"
      },
      "event_time": {
         "examples": [
            1614985631
         ],
         "format": "date-time",
         "title": "Whent he change was made",
         "type": "string"
      }
   },
   "$defs": {
      "TokenChange": {
         "description": "Type of change made to a token.",
         "enum": [
            "create",
            "revoke",
            "expire",
            "edit"
         ],
         "title": "TokenChange",
         "type": "string"
      },
      "TokenType": {
         "description": "The class of token.",
         "enum": [
            "session",
            "user",
            "notebook",
            "internal",
            "service"
         ],
         "title": "TokenType",
         "type": "string"
      }
   },
   "required": [
      "token",
      "username",
      "token_type",
      "scopes",
      "actor",
      "action"
   ]
}

Fields:

• action (gafaelfawr.models.history.TokenChange)

• actor (str)

• event_time (datetime.datetime)

• expires (datetime.datetime | None)

• ip_address (str | None)

• old_expires (datetime.datetime | None)

• old_scopes (list[str] | None)

• old_token_name (str | None)

• parent (str | None)

• scopes (list[str])

• service (str | None)

• token (str)

• token_name (str | None)

• token_type (gafaelfawr.models.token.TokenType)

• username (str)

Validators:

• normalize_datetime » event_time

• normalize_datetime » expires

• normalize_datetime » old_expires

• normalize_ip_address » ip_address

• normalize_scopes » old_scopes

• normalize_scopes » scopes

field action: TokenChange [Required]

field actor: str [Required]

Constraints:

• min_length = 1

• max_length = 64

field event_time: datetime [Optional]

Validated by:

• normalize_datetime

field expires: datetime | None = None

If the expiration was changed, this will be the new expiration of the token.

Validated by:

• normalize_datetime

field ip_address: str | None = None

May be null if the change was made internally, such as token deletion due to expiration.

Validated by:

• normalize_ip_address

field old_expires: datetime | None = None

This field will only be present for edit changes that changed the expiration of the token.

Validated by:

• normalize_datetime

field old_scopes: list[str] | None = None

This field will only be present for edit changes that changed the token scopes.

Validated by:

• normalize_scopes

field old_token_name: str | None = None

This field will only be present for edit changes to user tokens that changed the token name.

field parent: str | None = None

field scopes: list[str] [Required]

Validated by:

• normalize_scopes

field service: str | None = None

Only set for tokens of type internal.

field token: str [Required]

Constraints:

• min_length = 22

• max_length = 22

field token_name: str | None = None

Only set for tokens of type user. If the name was changed, this will be the new name of the token.

field token_type: TokenType [Required]

Class of token, chosen from:

• session: An interactive user web session

• user: A user-generated token that may be used programmatically

• notebook: The token delegated to a Jupyter notebook for the user

• internal: A service-to-service token used for internal sub-calls made as part of processing a user request

• service: A service-to-service token used for internal calls initiated by services, unrelated to a user request

field username: str [Required]

Constraints:

• min_length = 1

• max_length = 64

model_dump_reduced()

Convert to a dictionary while suppressing some fields.

The same as the standard Pydantic model_dump method, but excludes the old_ fields for changes other than edits and when the edit doesn’t change those fields.

Returns:

Dictionary representation of the object.

Return type:

dict

Notes

Knowing which fields to exclude requires understanding the semantics of the change (particularly when deciding whether to drop old_expires) in ways that are too complex to do with the standard Pydantic filtering API, hence the hand-rolled method.