Class RulesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class RulesClient : IRulesClient

Inheritance

object

RulesClient

Implements

IRulesClient

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)

Methods

CreateAsync(CreateRuleRequestContent, RequestOptions?, CancellationToken)

Create a new rule.

Note: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.

public WithRawResponseTask<CreateRuleResponseContent> CreateAsync(CreateRuleRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateRuleRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateRuleResponseContent>

Examples

await client.Rules.CreateAsync(new CreateRuleRequestContent { Name = "name", Script = "script" });

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a rule.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Rules.DeleteAsync("id");

GetAsync(string, GetRuleRequestParameters, RequestOptions?, CancellationToken)

Retrieve rule details. Accepts a list of fields to include or exclude in the result.

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

Parameters

id string

request GetRuleRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetRuleResponseContent>

Examples

await client.Rules.GetAsync(
    "id",
    new GetRuleRequestParameters { Fields = "fields", IncludeFields = true }
);

ListAsync(ListRulesRequestParameters, RequestOptions?, CancellationToken)

Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.

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

Parameters

request ListRulesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Rule>>

Examples

await client.Rules.ListAsync(
    new ListRulesRequestParameters
    {
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
        Enabled = true,
        Fields = "fields",
        IncludeFields = true,
    }
);

UpdateAsync(string, UpdateRuleRequestContent, RequestOptions?, CancellationToken)

Update an existing rule.

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

Parameters

id string

request UpdateRuleRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateRuleResponseContent>

Examples

await client.Rules.UpdateAsync("id", new UpdateRuleRequestContent());