LoginSuccessEvent

pydantic model gafaelfawr.events.LoginSuccessEvent

User successfully authenticated.

A user returned successfully from the identity provider after authenticating.

Parameters:

data (Any)

Show JSON schema

{
   "title": "LoginSuccessEvent",
   "description": "User successfully authenticated.\n\nA user returned successfully from the identity provider after\nauthenticating.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username of authenticated user",
         "title": "Username",
         "type": "string"
      },
      "elapsed": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "How long it took the user to complete the login process in seconds",
         "title": "Duration of login process (seconds)"
      }
   },
   "required": [
      "username"
   ]
}

Fields:

• elapsed (float | None)

• username (str)

field elapsed: float | None = None

How long it took the user to complete the login process in seconds

field username: str [Required]

Username of authenticated user

asdict()

Returns this model in dictionary form. This method differs from pydantic’s dict by converting all values to their Avro representation. It also doesn’t provide the exclude, include, by_alias, etc. parameters that dict provides.

Return type:

Dict[str, Any]

classmethod fake(**data)

Creates a fake instance of the model.

Attributes:

data: Dict[str, Any] represent the user values to use in the instance

Parameters:

data (Any)

Return type:

TypeVar(CT, bound= AvroBaseModel)

classmethod generate_dataclass()

Return type:

Type[TypeVar(CT, bound= AvroBaseModel)]

classmethod json_schema(*args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

serialize(serialization_type='avro')

Overrides the base AvroModel’s serialize method to inject this class’s standardization factory method

Parameters:

serialization_type (Literal['avro', 'avro-json'], default: 'avro')

Return type:

bytes

to_dict()

Return type:

Dict[str, Any]

validate_avro()

Validate that instance matches the avro schema

Return type:

bool

classmethod validate_structure()

Do runtime validation of fields.

Make sure all of the fields are compatible with the backing datastore (InfluxDB at the moment).

Return type:

None