Table of Contents

Interface IRulesClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public interface IRulesClient
Extension Methods

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.

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

Parameters

request CreateRuleRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateRuleResponseContent>

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a rule.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

Task

GetAsync(string, GetRuleRequestParameters, RequestOptions?, CancellationToken)

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

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>

ListAsync(ListRulesRequestParameters, RequestOptions?, CancellationToken)

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

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

Parameters

request ListRulesRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<Rule>>

UpdateAsync(string, UpdateRuleRequestContent, RequestOptions?, CancellationToken)

Update an existing rule.

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>