Class ScimConfigurationClient

Namespace

Auth0.ManagementApi.Connections

Assembly

Auth0.ManagementApi.dll

public class ScimConfigurationClient : IScimConfigurationClient

Inheritance

object

ScimConfigurationClient

Implements

IScimConfigurationClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Properties

Tokens

public ITokensClient Tokens { get; }

Property Value

ITokensClient

Methods

CreateAsync(string, Optional<CreateScimConfigurationRequestContent?>, RequestOptions?, CancellationToken)

Create a scim configuration for a connection.

public WithRawResponseTask<CreateScimConfigurationResponseContent> CreateAsync(string id, Optional<CreateScimConfigurationRequestContent?> request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request Optional<CreateScimConfigurationRequestContent>

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateScimConfigurationResponseContent>

Examples

await client.Connections.ScimConfiguration.CreateAsync(
    "id",
    new CreateScimConfigurationRequestContent()
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Deletes a scim configuration by its connectionId.

public Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Connections.ScimConfiguration.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

Retrieves a scim configuration by its connectionId.

public WithRawResponseTask<GetScimConfigurationResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetScimConfigurationResponseContent>

Examples

await client.Connections.ScimConfiguration.GetAsync("id");

GetDefaultMappingAsync(string, RequestOptions?, CancellationToken)

Retrieves a scim configuration's default mapping by its connectionId.

public WithRawResponseTask<GetScimConfigurationDefaultMappingResponseContent> GetDefaultMappingAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetScimConfigurationDefaultMappingResponseContent>

Examples

await client.Connections.ScimConfiguration.GetDefaultMappingAsync("id");

ListAsync(ListScimConfigurationsRequestParameters, RequestOptions?, CancellationToken)

Retrieve a list of SCIM configurations of a tenant.

public Task<Pager<ScimConfiguration>> ListAsync(ListScimConfigurationsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListScimConfigurationsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ScimConfiguration>>

Examples

await client.Connections.ScimConfiguration.ListAsync(
    new ListScimConfigurationsRequestParameters { From = "from", Take = 1 }
);

UpdateAsync(string, UpdateScimConfigurationRequestContent, RequestOptions?, CancellationToken)

Update a scim configuration by its connectionId.

public WithRawResponseTask<UpdateScimConfigurationResponseContent> UpdateAsync(string id, UpdateScimConfigurationRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateScimConfigurationRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateScimConfigurationResponseContent>

Examples

await client.Connections.ScimConfiguration.UpdateAsync(
    "id",
    new UpdateScimConfigurationRequestContent
    {
        UserIdAttribute = "user_id_attribute",
        Mapping = new List<ScimMappingItem>() { new ScimMappingItem() },
    }
);