Class RenderingClient

Namespace

Auth0.ManagementApi.Prompts

Assembly

Auth0.ManagementApi.dll

public class RenderingClient : IRenderingClient

Inheritance

object

RenderingClient

Implements

IRenderingClient

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

BulkUpdateAsync(BulkUpdateAculRequestContent, RequestOptions?, CancellationToken)

Learn more about configuring render settings for advanced customization.

public WithRawResponseTask<BulkUpdateAculResponseContent> BulkUpdateAsync(BulkUpdateAculRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request BulkUpdateAculRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<BulkUpdateAculResponseContent>

Examples

await client.Prompts.Rendering.BulkUpdateAsync(
    new BulkUpdateAculRequestContent
    {
        Configs = new List<AculConfigsItem>()
        {
            new AculConfigsItem
            {
                Prompt = PromptGroupNameEnum.Login,
                Screen = ScreenGroupNameEnum.Login,
            },
        },
    }
);

GetAsync(PromptGroupNameEnum, ScreenGroupNameEnum, RequestOptions?, CancellationToken)

Get render settings for a screen.

public WithRawResponseTask<GetAculResponseContent> GetAsync(PromptGroupNameEnum prompt, ScreenGroupNameEnum screen, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

prompt PromptGroupNameEnum

screen ScreenGroupNameEnum

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetAculResponseContent>

Examples

await client.Prompts.Rendering.GetAsync(PromptGroupNameEnum.Login, ScreenGroupNameEnum.Login);

ListAsync(ListAculsRequestParameters, RequestOptions?, CancellationToken)

Get render setting configurations for all screens.

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

Parameters

request ListAculsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ListAculsResponseContentItem>>

Examples

await client.Prompts.Rendering.ListAsync(
    new ListAculsRequestParameters
    {
        Fields = "fields",
        IncludeFields = true,
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
        Prompt = "prompt",
        Screen = "screen",
        RenderingMode = AculRenderingModeEnum.Advanced,
    }
);

UpdateAsync(PromptGroupNameEnum, ScreenGroupNameEnum, UpdateAculRequestContent, RequestOptions?, CancellationToken)

Learn more about configuring render settings for advanced customization.

public WithRawResponseTask<UpdateAculResponseContent> UpdateAsync(PromptGroupNameEnum prompt, ScreenGroupNameEnum screen, UpdateAculRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

prompt PromptGroupNameEnum

screen ScreenGroupNameEnum

request UpdateAculRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateAculResponseContent>

Examples

await client.Prompts.Rendering.UpdateAsync(
    PromptGroupNameEnum.Login,
    ScreenGroupNameEnum.Login,
    new UpdateAculRequestContent()
);