Struct ScimOptions 

pub struct ScimOptions {
    pub provider_ownership: ProviderOwnershipOptions,
    pub required_role: Option<Vec<String>>,
    pub default_scim: Vec<DefaultScimProvider>,
    pub token_storage: ScimTokenStorage,
    pub before_token_generated: Option<BeforeScimTokenGeneratedHook>,
    pub after_token_generated: Option<AfterScimTokenGeneratedHook>,
    pub bulk_mode: ScimBulkMode,
    pub deprovision_mode: ScimDeprovisionMode,
    pub audit_event: Option<ScimAuditEventResolver>,
}

SCIM plugin options.

use rustauth_scim::{ScimOptions, ScimTokenStorage};

let options = ScimOptions::default();
assert!(matches!(options.token_storage, ScimTokenStorage::Hashed));

Fields

provider_ownership: ProviderOwnershipOptions

Whether provider connections are tied to the user who generated them.

required_role: Option<Vec<String>>

Organization roles allowed to manage org-scoped SCIM providers.

default_scim: Vec<DefaultScimProvider>

Static SCIM providers checked before database-backed providers.

token_storage: ScimTokenStorage

How generated SCIM tokens are stored.

before_token_generated: Option<BeforeScimTokenGeneratedHook>

Callback invoked after built-in authorization and before persistence.

after_token_generated: Option<AfterScimTokenGeneratedHook>

Callback invoked after a provider has been persisted.

bulk_mode: ScimBulkMode

Bulk commit strategy (ScimBulkMode::Independent by default).

deprovision_mode: ScimDeprovisionMode

User delete semantics for SCIM deprovision.

audit_event: Option<ScimAuditEventResolver>

Optional async audit sink (also logged through AuthContext::logger).

Implementations

impl ScimOptions

pub fn new() -> Self

Create default SCIM plugin options.

pub fn provider_ownership(self, ownership: ProviderOwnershipOptions) -> Self

Configure provider ownership rules.

pub fn required_role(self, roles: Vec<String>) -> Self

Set organization roles allowed to manage org-scoped SCIM providers.

pub fn default_scim(self, providers: Vec<DefaultScimProvider>) -> Self

Add statically configured SCIM providers.

pub fn token_storage(self, storage: ScimTokenStorage) -> Self

Set how generated SCIM tokens are stored.

pub fn before_token_generated(self, hook: BeforeScimTokenGeneratedHook) -> Self

Set the hook invoked before a SCIM token is persisted.

pub fn after_token_generated(self, hook: AfterScimTokenGeneratedHook) -> Self

Set the hook invoked after a SCIM token is persisted.

pub fn bulk_mode(self, mode: ScimBulkMode) -> Self

Set bulk commit strategy.

pub fn deprovision_mode(self, mode: ScimDeprovisionMode) -> Self

Set user delete semantics for SCIM deprovision.

pub fn audit_event(self, resolver: ScimAuditEventResolver) -> Self

Set an async audit event sink.

Trait Implementations

impl Clone for ScimOptions

fn clone(&self) -> ScimOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScimOptions

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScimOptions

fn default() -> Self

Returns the “default value” for a type.