Class BrandingClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /branding endpoints.

public class BrandingClient : BaseClient, IBrandingClient

Inheritance

object

BaseClient

BrandingClient

Implements

IBrandingClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BrandingClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of BrandingClient.

public BrandingClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

DeleteUniversalLoginTemplateAsync(CancellationToken)

Delete the template for the New Universal Login Experience

public Task DeleteUniversalLoginTemplateAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous delete operation.

GetAsync(CancellationToken)

Retrieves branding settings for a tenant.

public Task<Branding> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Branding>

A Branding containing the branding for the tenant.

GetUniversalLoginTemplateAsync(CancellationToken)

Retrieves the template for the New Universal Login Experience.

public Task<UniversalLoginTemplate> GetUniversalLoginTemplateAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<UniversalLoginTemplate>

The UniversalLoginTemplate for the new universal login experience.

SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest, CancellationToken)

Sets the template for the New Universal Login Experience.

public Task<UniversalLoginTemplate> SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request UniversalLoginTemplateUpdateRequest

The UniversalLoginTemplateUpdateRequest containing details of the template to set.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<UniversalLoginTemplate>

The newly updated UniversalLoginTemplate.

UpdateAsync(BrandingUpdateRequest, CancellationToken)

s Updates the branding for a tenant.

public Task<Branding> UpdateAsync(BrandingUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request BrandingUpdateRequest

A BrandingUpdateRequest containing the branding information to update.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Branding>

The newly updated Branding.