Struct ScimOperationRequest 

pub struct ScimOperationRequest {
    pub operation: ScimOperationType,
    pub resource_type: String,
    pub resource_id: Option<String>,
    pub data: Option<Value>,
    pub query: Option<ScimQuery>,
    pub tenant_context: Option<TenantContext>,
    pub request_id: Option<String>,
    pub expected_version: Option<RawVersion>,
}

Structured request for SCIM operations

This type encapsulates all the information needed to perform a SCIM operation in a transport-agnostic way.

Fields

operation: ScimOperationType

The type of operation to perform

resource_type: String

The resource type (e.g., “User”, “Group”)

resource_id: Option<String>

Resource ID for operations that target a specific resource

data: Option<Value>

Data payload for create/update operations

query: Option<ScimQuery>

Query parameters for list/search operations

tenant_context: Option<TenantContext>

Tenant context for multi-tenant operations

request_id: Option<String>

Request ID for tracing and correlation

expected_version: Option<RawVersion>

Expected version for conditional operations

Implementations

impl ScimOperationRequest

pub fn create(resource_type: impl Into<String>, data: Value) -> Self

Create a new create operation request.

pub fn get( resource_type: impl Into<String>, resource_id: impl Into<String>, ) -> Self

Create a new get operation request.

pub fn update( resource_type: impl Into<String>, resource_id: impl Into<String>, data: Value, ) -> Self

Create a new update operation request.

pub fn delete( resource_type: impl Into<String>, resource_id: impl Into<String>, ) -> Self

Create a new delete operation request.

pub fn list(resource_type: impl Into<String>) -> Self

Create a new list operation request.

pub fn search( resource_type: impl Into<String>, attribute: impl Into<String>, value: Value, ) -> Self

Create a new search operation request.

pub fn get_schemas() -> Self

Create a new get schemas operation request.

pub fn get_schema(schema_id: impl Into<String>) -> Self

Create a new get schema operation request.

pub fn exists( resource_type: impl Into<String>, resource_id: impl Into<String>, ) -> Self

Create a new resource exists operation request.

pub fn with_tenant(self, tenant_context: TenantContext) -> Self

Add tenant context to the request.

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Add request ID to the request.

pub fn with_query(self, query: ScimQuery) -> Self

Add query parameters to the request.

pub fn with_expected_version(self, version: impl Into<RawVersion>) -> Self

Add expected version for conditional operations.

This enables ETag-based concurrency control for update and delete operations. The operation will only succeed if the current resource version matches the expected version.

Examples

use scim_server::operation_handler::ScimOperationRequest;
use scim_server::resource::version::{RawVersion, HttpVersion};
use serde_json::json;

let version: HttpVersion = "\"abc123\"".parse().unwrap();
let request = ScimOperationRequest::update(
    "User",
    "123",
    json!({"userName": "updated.name"})
).with_expected_version(version);

Trait Implementations

impl Clone for ScimOperationRequest

fn clone(&self) -> ScimOperationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScimOperationRequest

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

Formats the value using the given formatter.

impl PartialEq for ScimOperationRequest

fn eq(&self, other: &ScimOperationRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScimOperationRequest