Class ModulesClient

Namespace

Auth0.ManagementApi.Actions

Assembly

Auth0.ManagementApi.dll

public class ModulesClient : IModulesClient

Inheritance

object

ModulesClient

Implements

IModulesClient

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

Versions

public IVersionsClient Versions { get; }

Property Value

IVersionsClient

Methods

CreateAsync(CreateActionModuleRequestContent, RequestOptions?, CancellationToken)

Create a new Actions Module for reusable code across actions.

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

Parameters

request CreateActionModuleRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateActionModuleResponseContent>

Examples

await client.Actions.Modules.CreateAsync(
    new CreateActionModuleRequestContent { Name = "name", Code = "code" }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Permanently delete an Actions Module. This will fail if the module is still in use by any actions.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Actions.Modules.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details of a specific Actions Module by its unique identifier.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetActionModuleResponseContent>

Examples

await client.Actions.Modules.GetAsync("id");

ListActionsAsync(string, GetActionModuleActionsRequestParameters, RequestOptions?, CancellationToken)

Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.

public Task<Pager<ActionModuleAction>> ListActionsAsync(string id, GetActionModuleActionsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request GetActionModuleActionsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ActionModuleAction>>

Examples

await client.Actions.Modules.ListActionsAsync(
    "id",
    new GetActionModuleActionsRequestParameters { Page = 1, PerPage = 1 }
);

ListAsync(GetActionModulesRequestParameters, RequestOptions?, CancellationToken)

Retrieve a paginated list of all Actions Modules with optional filtering and totals.

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

Parameters

request GetActionModulesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ActionModuleListItem>>

Examples

await client.Actions.Modules.ListAsync(
    new GetActionModulesRequestParameters { Page = 1, PerPage = 1 }
);

RollbackAsync(string, RollbackActionModuleRequestParameters, RequestOptions?, CancellationToken)

Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.

public WithRawResponseTask<RollbackActionModuleResponseContent> RollbackAsync(string id, RollbackActionModuleRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request RollbackActionModuleRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<RollbackActionModuleResponseContent>

Examples

await client.Actions.Modules.RollbackAsync(
    "id",
    new RollbackActionModuleRequestParameters { ModuleVersionId = "module_version_id" }
);

UpdateAsync(string, UpdateActionModuleRequestContent, RequestOptions?, CancellationToken)

Update properties of an existing Actions Module, such as code, dependencies, or secrets.

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

Parameters

id string

request UpdateActionModuleRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateActionModuleResponseContent>

Examples

await client.Actions.Modules.UpdateAsync("id", new UpdateActionModuleRequestContent());