Struct OrganizationPlugin 

pub struct OrganizationPlugin { /* private fields */ }

Organization plugin for multi-tenancy support

Implementations

impl OrganizationPlugin

pub fn callbacks<S: AuthSchema>( self, callbacks: OrganizationCallbacks<S>, ) -> impl AuthPlugin<S>

Attach typed notification callbacks after configuring the organization options.

impl OrganizationPlugin

pub async fn add_member<S: AuthSchema>( &self, input: AddMemberInput, request: Option<&AuthRequest>, ctx: &AuthContext<S>, ) -> AuthResult<Member>

Add a member from a trusted server context, optionally using an authenticated request.

impl OrganizationPlugin

pub fn new() -> Self

pub fn with_config(config: OrganizationConfig) -> Self

pub fn dynamic_access_control(self, val: bool) -> Self

pub fn maximum_roles_per_organization(self, val: usize) -> Self

pub fn allow_user_to_create_organization(self, val: bool) -> Self

pub fn organization_limit(self, val: usize) -> Self

pub fn membership_limit(self, val: usize) -> Self

pub fn creator_role(self, val: impl Into<String>) -> Self

pub fn invitation_expires_in(self, val: f64) -> Self

pub fn invitation_limit(self, val: usize) -> Self

pub fn cancel_pending_invitations_on_re_invite(self, val: bool) -> Self

pub fn require_email_verification_on_invitation(self, val: bool) -> Self

pub fn disable_organization_deletion(self, val: bool) -> Self

impl OrganizationPlugin

pub fn membership_limit_callback( self, callback: Arc<dyn MembershipLimitPolicy>, ) -> Self

Configure dynamic organization capacity. Listing retains the upstream default page size.

pub fn hooks(self, hooks: Arc<dyn OrganizationHooks>) -> Self

Configure application lifecycle hooks.

pub fn policy(self, policy: Arc<dyn OrganizationPolicy>) -> Self

Configure asynchronous organization options.

pub fn teams(self, teams: OrganizationTeamsConfig) -> Self

Configure organization teams.

pub fn access_control(self, ac: HashMap<String, Vec<String>>) -> Self

Configure access-control resource statements.

pub fn custom_send_invitation_email( self, sender: Arc<dyn SendInvitationEmail>, ) -> Self

Configure delivery for new and resent invitations.

Trait Implementations

impl<S: AuthSchema> AuthPlugin<S> for OrganizationPlugin

fn name(&self) -> &'static str

Plugin name - should be unique

fn openapi(&self) -> AuthResult<OpenApiPluginMetadata>

Document this configured plugin without invoking application field policies.

fn on_init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut AuthInitContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the plugin is initialized

fn routes(&self) -> Vec<AuthRoute>

Routes that this plugin handles

fn after_request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Inspect or extend the final route response after session cookies are applied.

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<Option<AuthResponse>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each request - return Some(response) to handle, None to pass through

fn telemetry_plugin_id(&self) -> Option<&'static str>

Return the upstream plugin ID; core option wrappers have no plugin ID.

fn password_hasher(&self) -> Option<Arc<dyn PasswordHasher>>

Select the base password hasher before plugin initialization wraps it.

fn telemetry(&self, _options: &mut PluginTelemetry)

Report configured options without invoking callbacks or initializing the plugin.

fn rate_limits(&self) -> Result<Vec<PluginRateLimit>, AuthError>

Default endpoint limits, overridden by explicit application limits.

fn on_http_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Inspect an HTTP request after rate limiting and before endpoint middleware. Native API calls do not run this hook. A response skips endpoint hooks.

fn on_http_response<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect the HTTP router response, including route misses and body errors. Early HTTP request responses and native endpoint calls skip this hook. A replacement response stops the remaining HTTP response hooks.

fn before_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<BeforeRequestAction>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called for a registered endpoint after HTTP body decoding and origin checks.

impl Clone for OrganizationPlugin

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for OrganizationPlugin

fn default() -> Self

Returns the “default value” for a type.