Audit

audit

AuditLogActionId

Bases: str

Unique ID of an audit log action.

AuditLogEventId

Bases: str

Unique ID of an audit log event.

AuditLogEvent

Bases: BaseModel

Event recorded in the audit log.

Audit data is guaranteed to not contain any secret information.

event_id class-attribute instance-attribute

event_id = Field(
    description="ID of the audit log event.",
    validation_alias="eventId",
    serialization_alias="eventId",
)

actor class-attribute instance-attribute

actor = Field(description='Actor causing the event.')

event class-attribute instance-attribute

event = Field(
    description="Type of the event that was recorded."
)

data class-attribute instance-attribute

data = Field(
    description="Additional audit data associated with the event."
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Timestamp indicating when the audit log event was recorded.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

action class-attribute instance-attribute

action = Field(
    default=None,
    description="Action the event has been caused by (if any).",
)

job class-attribute instance-attribute

job = Field(
    default=None,
    description="Job the event has been caused by (if any).",
)

AuditLogEventAction

Bases: BaseModel

Action that caused an event.

action_id class-attribute instance-attribute

action_id = Field(
    description="ID of the action.",
    validation_alias="actionId",
    serialization_alias="actionId",
)

AuditLogEventJob

Bases: BaseModel

Job that caused an event.

job_id class-attribute instance-attribute

job_id = Field(
    description="ID of the job.",
    validation_alias="jobId",
    serialization_alias="jobId",
)

AuditLogAction

Bases: BaseModel

Action recorded in the audit log.

Audit data is guaranteed to not contain any secret information.

action_id class-attribute instance-attribute

action_id = Field(
    description="ID of the audit log action.",
    validation_alias="actionId",
    serialization_alias="actionId",
)

actor class-attribute instance-attribute

actor = Field(
    description="Actor that performed the action."
)

action class-attribute instance-attribute

action = Field(
    description="Type of the action that was performed."
)

data class-attribute instance-attribute

data = Field(
    description="Additional audit data associated with the action."
)

status class-attribute instance-attribute

status = Field(
    description="Status associated with the action"
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Timestamp indicating when the audit log action was recorded.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

QueryAuditLogEventsAction

Bases: BaseModel

Query the events recorded in the audit log.

Requires administrator permissions.

QueryAuditLogEventsOutput

Bases: BaseModel

Output of querying the events recorded in the audit log.

events class-attribute instance-attribute

events = Field(description='List of audit events.')

QueryAuditLogActionsAction

Bases: BaseModel

Query the actions recorded in the audit log.

Requires administrator permissions.

QueryAuditLogActionsOutput

Bases: BaseModel

Output of querying the actions recorded in the audit log.

actions class-attribute instance-attribute

actions = Field(description='List of actions.')

AuditLogActionStatus_Rejected

Bases: RootModel[Literal['Rejected']]

AuditLogActionStatus_Panicked

Bases: RootModel[Literal['Panicked']]

AuditLogActionStatus_Succeeded

Bases: RootModel[Literal['Succeeded']]

AuditLogActionStatus_Failed

Bases: RootModel[Literal['Failed']]

AuditLogActionStatus_Pending

Bases: RootModel[Literal['Pending']]

AuditLogActionStatus

AuditLogActionStatus = (
    AuditLogActionStatus_Rejected
    | AuditLogActionStatus_Panicked
    | AuditLogActionStatus_Succeeded
    | AuditLogActionStatus_Failed
    | AuditLogActionStatus_Pending
)