Skip to main content

Module auth_operations

Module auth_operations 

Source
Expand description

Grouped operation facades over AuthFramework.

Light reference wrappers (e.g. UserOperations, TokenOperations) returned by the accessor methods on AuthFramework. Not usually imported directly — use auth.users(), auth.tokens(), etc. Grouped operation facades over AuthFramework.

Each *Operations struct is a lightweight view (holds only a lifetime-bound reference to the framework) that exposes a focused subset of the full API. They are created by the corresponding accessor on AuthFramework (e.g. users()).

§Request structs

Several operations accept structured request types instead of long parameter lists. These types carry required parameters via a constructor and optional parameters via builder methods:

  • [SessionCreateRequest] — session creation with optional IP / user-agent.
  • [AuditLogQuery] — filtered audit log queries.
  • [UserListQuery] — user listing with pagination and filtering.
  • [PermissionContext] — context data for dynamic permission evaluation.
  • [DelegationRequest] — permission delegation with required fields.
  • [ExecutionMode] — DryRun vs Execute for maintenance operations.
  • [UserStatus] — Active vs Inactive for user account state.
  • [SessionFilter] — ActiveOnly vs IncludeInactive for session listing.

Structs§

AdminOperations
Focused advanced administration operations exposed from AuthFramework::admin.
AuditLogQuery
Filtering criteria for AuditOperations::query_permission_logs.
AuditOperations
Focused audit log operations exposed via AuthFramework::audit().
AuthorizationOperations
Focused authorization operations exposed via AuthFramework::authorization().
DelegationRequest
Request type for AdminOperations::delegate.
MaintenanceOperations
Focused maintenance operations exposed via AuthFramework::maintenance().
MfaOperations
Focused multi-factor authentication operations exposed via AuthFramework::mfa().
MonitoringOperations
Focused monitoring and health operations exposed via AuthFramework::monitoring().
PermissionContext
Context data for dynamic permission evaluation (ABAC).
SessionCreateRequest
Request type for SessionOperations::create.
SessionOperations
Focused session-management operations exposed from AuthFramework::sessions.
TokenCreateRequest
Builder for TokenOperations::create_token.
TokenOperations
Focused token-management operations exposed from AuthFramework::tokens.
UserListQuery
Query type for listing users with pagination and filtering.
UserOperations
Focused user-management operations exposed from AuthFramework::users.

Enums§

ExecutionMode
Controls whether a maintenance operation (backup, restore, reset) actually modifies state or merely previews what would happen.
SessionFilter
Filter for session listing queries.
UserStatus
Whether a user account should be active (able to log in) or inactive (locked out).