> ## Documentation Index
> Fetch the complete documentation index at: https://klef.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ScimClient

> Calls a SCIM 2.0 service.

```csharp
public sealed class ScimClient
```

## Constructors

```csharp
public ScimClient(HttpClient http, Uri root, string userObject, string mediaType = "application/scim+json", string? readQuery = null, Func<HttpRequestMessage, CancellationToken, Task>? authorize = null, int maxPageSize = 100)
```

Calls a SCIM 2.0 service.

### Parameters

**http** `HttpClient` *required*

**root** `Uri` *required*

**userObject** `string` *required*

The manifest object a SCIM user is, such as user.

**mediaType** `string`

**readQuery** `string`

**authorize** `Func\<HttpRequestMessage, CancellationToken, Task\>`

**maxPageSize** `int`

## Fields

**DefaultPageSize** `int` *required*

The page size a service is asked for by default.

**EnterpriseUserSchema** `string` *required*

The enterprise user extension's URN.

**Groups** `string` *required*

The groups resource's path.

**GroupSchema** `string` *required*

The core group schema's URN.

**MediaType** `string` *required*

The SCIM JSON media type.

**PatchSchema** `string` *required*

The patch operation message's URN.

**Users** `string` *required*

The users resource's path.

**UserSchema** `string` *required*

The core user schema's URN.

## Methods

### CreateAsync()

```csharp
public Task<TResponse> CreateAsync<TRequest, TResponse>(string resource, TRequest body, CancellationToken cancellationToken) where TRequest : notnull where TResponse : ScimResource
```

Creates a resource and returns it.

#### Type Parameters

**TRequest** *required*

**TResponse** *required*

#### Parameters

**resource** `string` *required*

**body** `TRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<TResponse>`

### DeleteAsync()

```csharp
public Task<bool> DeleteAsync(string resource, string id, CancellationToken cancellationToken)
```

Deletes a resource, reporting whether it existed.

#### Parameters

**resource** `string` *required*

**id** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<bool>`

### Equal()

```csharp
public static string Equal(string attribute, string value)
```

Builds an equality filter.

#### Parameters

**attribute** `string` *required*

**value** `string` *required*

#### Returns

`string`

### FindAsync()

```csharp
public Task<T?> FindAsync<T>(string resource, string filter, CancellationToken cancellationToken) where T : ScimResource
```

Finds the first resource a filter matches.

#### Type Parameters

**T** *required*

#### Parameters

**resource** `string` *required*

**filter** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<T>`

### GetAsync()

```csharp
public Task<T?> GetAsync<T>(string resource, string id, CancellationToken cancellationToken) where T : ScimResource
```

Reads one resource, if it exists.

#### Type Parameters

**T** *required*

#### Parameters

**resource** `string` *required*

**id** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<T>`

### GetUserAsync()

```csharp
public Task<T> GetUserAsync<T>(string id, CancellationToken cancellationToken) where T : ScimResource
```

Reads one user by its id.

#### Type Parameters

**T** *required*

#### Parameters

**id** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<T>`

### Id()

```csharp
public static string Id(ScimResource resource)
```

Gets a resource's id.

#### Parameters

**resource** `ScimResource` *required*

#### Returns

`string`

### Label()

```csharp
public static string Label(ScimUser user)
```

Gets the name a user is shown by.

#### Parameters

**user** `ScimUser` *required*

#### Returns

`string`

### ListAsync()

```csharp
public Task<IReadOnlyList<T>> ListAsync<T>(string resource, CancellationToken cancellationToken) where T : ScimResource
```

Lists every resource of one type.

#### Type Parameters

**T** *required*

#### Parameters

**resource** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<IReadOnlyList<T>>`

### Members()

```csharp
public static IEnumerable<string> Members(ScimGroup group)
```

Lists the ids of a group's members.

#### Parameters

**group** `ScimGroup` *required*

#### Returns

`IEnumerable<string>`

### PageAsync()

```csharp
public Task<Page<T>> PageAsync<T>(string resource, PageRequest page, CancellationToken cancellationToken) where T : ScimResource
```

Reads one page of a resource type.

#### Type Parameters

**T** *required*

#### Parameters

**resource** `string` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<<T>>>`

```csharp
public Task<ScimListResponse<T>> PageAsync<T>(string resource, int startIndex, int count, CancellationToken cancellationToken) where T : ScimResource
```

Reads one page as the service answers it.

#### Type Parameters

**T** *required*

#### Parameters

**resource** `string` *required*

**startIndex** `int` *required*

**count** `int` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<ScimListResponse<<T>>>`

### Parents()

```csharp
public static IReadOnlyDictionary<string, IReadOnlyList<string>> Parents(IReadOnlyList<ScimGroup> groups)
```

Maps each group to its direct parents.

#### Parameters

**groups** `IReadOnlyList\<ScimGroup\>` *required*

**Type:** `IReadOnlyList<ScimGroup>`

#### Returns

`IReadOnlyDictionary<string, IReadOnlyList<string>>`

### PatchAsync()

```csharp
public Task PatchAsync(string resource, string id, IEnumerable<ScimOperation> operations, CancellationToken cancellationToken)
```

Patches one resource by its id.

#### Parameters

**resource** `string` *required*

**id** `string` *required*

**operations** `IEnumerable\<ScimOperation\>` *required*

**Type:** `IEnumerable<ScimOperation>`

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`

### PatchUserAsync()

```csharp
public Task PatchUserAsync(string id, IEnumerable<ScimOperation> operations, CancellationToken cancellationToken)
```

Patches one user by its id.

#### Parameters

**id** `string` *required*

**operations** `IEnumerable\<ScimOperation\>` *required*

**Type:** `IEnumerable<ScimOperation>`

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.