Table of Contents

Interface IBrandingClient

Namespace
Auth0.ManagementApi.Clients
Assembly
Auth0.ManagementApi.dll
public interface IBrandingClient

Methods

CreateBrandingPhoneNotificationTemplateAsync(BrandingPhoneNotificationTemplateCreateRequest, CancellationToken)

Create a phone notification template

Task<BrandingPhoneNotificationTemplate> CreateBrandingPhoneNotificationTemplateAsync(BrandingPhoneNotificationTemplateCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request BrandingPhoneNotificationTemplateCreateRequest

BrandingPhoneNotificationTemplateCreateRequest containing information on the template to be created

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneNotificationTemplate>

Newly created BrandingPhoneNotificationTemplate

CreateBrandingThemeAsync(BrandingThemeCreateRequest, CancellationToken)

Create branding theme.

Task<BrandingTheme> CreateBrandingThemeAsync(BrandingThemeCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request BrandingThemeCreateRequest

A BrandingThemeCreateRequest containing information required for creating a BrandingTheme

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingTheme>

A BrandingTheme

CreatePhoneProviderAsync(BrandingPhoneProviderCreateRequest, CancellationToken)

Create a phone provider . The credentials object requires different properties depending on the phone provider (which is specified using the name property).

Task<BrandingPhoneProvider> CreatePhoneProviderAsync(BrandingPhoneProviderCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request BrandingPhoneProviderCreateRequest

BrandingPhoneProviderCreateRequest containing information required to create a BrandingPhoneProvider

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneProvider>

The newly created BrandingPhoneProvider

DeleteBrandingPhoneNotificationTemplateAsync(string, CancellationToken)

Delete a phone notification template

Task DeleteBrandingPhoneNotificationTemplateAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the BrandingPhoneNotificationTemplate

cancellationToken CancellationToken

CancellationToken

Returns

Task

DeleteBrandingThemeAsync(string, CancellationToken)

Delete branding theme.

Task DeleteBrandingThemeAsync(string brandingThemeId, CancellationToken cancellationToken = default)

Parameters

brandingThemeId string

ID of the branding Theme to delete

cancellationToken CancellationToken

CancellationToken

Returns

Task

DeletePhoneProviderAsync(string, CancellationToken)

Delete the configured phone provider.

Task DeletePhoneProviderAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the BrandingPhoneProvider to delete

cancellationToken CancellationToken

CancellationToken

Returns

Task

DeleteUniversalLoginTemplateAsync(CancellationToken)

Delete the template for the New Universal Login Experience

Task DeleteUniversalLoginTemplateAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous delete operation.

GetAllBrandingPhoneNotificationTemplatesAsync(BrandingPhoneNotificationTemplatesGetRequest, CancellationToken)

Get a list of phone notification templates

Task<IList<BrandingPhoneNotificationTemplate>> GetAllBrandingPhoneNotificationTemplatesAsync(BrandingPhoneNotificationTemplatesGetRequest request, CancellationToken cancellationToken = default)

Parameters

request BrandingPhoneNotificationTemplatesGetRequest

BrandingPhoneNotificationTemplatesGetRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<IList<BrandingPhoneNotificationTemplate>>

IList<T> of BrandingPhoneNotificationTemplate

GetAllPhoneProvidersAsync(BrandingPhoneProviderGetRequest, CancellationToken)

Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

Task<IList<BrandingPhoneProvider>> GetAllPhoneProvidersAsync(BrandingPhoneProviderGetRequest request, CancellationToken cancellationToken = default)

Parameters

request BrandingPhoneProviderGetRequest

BrandingPhoneProviderGetRequest

cancellationToken CancellationToken

Returns

Task<IList<BrandingPhoneProvider>>

List of BrandingPhoneProviders

GetAsync(CancellationToken)

Retrieve branding settings.

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.

GetBrandingPhoneNotificationTemplateAsync(string, CancellationToken)

Get a phone notification template

Task<BrandingPhoneNotificationTemplate> GetBrandingPhoneNotificationTemplateAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the BrandingPhoneNotificationTemplate

cancellationToken CancellationToken

Returns

Task<BrandingPhoneNotificationTemplate>

BrandingPhoneNotificationTemplate

GetBrandingThemeAsync(string, CancellationToken)

Retrieve branding theme.

Task<BrandingTheme> GetBrandingThemeAsync(string brandingThemeId, CancellationToken cancellationToken = default)

Parameters

brandingThemeId string

ID of the branding Theme to retrieve

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingTheme>

The BrandingTheme

GetDefaultBrandingThemeAsync(CancellationToken)

Retrieve default branding theme.

Task<BrandingTheme> GetDefaultBrandingThemeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingTheme>

The default BrandingTheme

GetPhoneProviderAsync(string, CancellationToken)

Retrieve phone provider details. A list of fields to include or exclude may also be specified.

Task<BrandingPhoneProvider> GetPhoneProviderAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the BrandingPhoneProvider to be retrieved.

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneProvider>

BrandingPhoneProvider

GetUniversalLoginTemplateAsync(CancellationToken)

Retrieves the template for the New Universal Login Experience.

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.

ResetBrandingPhoneNotificationTemplate(string, CancellationToken)

Resets a phone notification template values

Task<BrandingPhoneNotificationTemplate> ResetBrandingPhoneNotificationTemplate(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the Notification Template to be reset

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneNotificationTemplate>

Updated BrandingPhoneNotificationTemplate

SendBrandingPhoneTemplateTestNotificationAsync(string, BrandingPhoneTestNotificationRequest, CancellationToken)

Send a test phone notification for the configured template

Task<BrandingPhoneTestNotificationResponse> SendBrandingPhoneTemplateTestNotificationAsync(string id, BrandingPhoneTestNotificationRequest request, CancellationToken cancellationToken = default)

Parameters

id string

Id of the Branding Phone Notification Template

request BrandingPhoneTestNotificationRequest

BrandingPhoneTestNotificationRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneTestNotificationResponse>

BrandingPhoneTestNotificationResponse

SendBrandingPhoneTestNotificationAsync(string, BrandingPhoneTestNotificationRequest, CancellationToken)

Send a test phone notification for the configured provider

Task<BrandingPhoneTestNotificationResponse> SendBrandingPhoneTestNotificationAsync(string id, BrandingPhoneTestNotificationRequest request, CancellationToken cancellationToken = default)

Parameters

id string

ID of the BrandingPhoneProvider

request BrandingPhoneTestNotificationRequest

BrandingPhoneTestNotificationRequest containing information on whom to send the notification to.

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneTestNotificationResponse>

BrandingPhoneTestNotificationResponse

SetUniversalLoginTemplateAsync(UniversalLoginTemplateUpdateRequest, CancellationToken)

Sets the template for the New Universal Login Experience.

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.

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.

UpdateBrandingPhoneNotificationTemplate(string, BrandingPhoneNotificationTemplateUpdateRequest, CancellationToken)

Update a phone notification template

Task<BrandingPhoneNotificationTemplate> UpdateBrandingPhoneNotificationTemplate(string id, BrandingPhoneNotificationTemplateUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

ID of the Notification Template to be updated

request BrandingPhoneNotificationTemplateUpdateRequest

BrandingPhoneNotificationTemplateUpdateRequest containing information to be updated

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneNotificationTemplate>

Updated BrandingPhoneNotificationTemplate

UpdateBrandingThemeAsync(string, BrandingThemeUpdateRequest, CancellationToken)

Update branding theme.

Task<BrandingTheme> UpdateBrandingThemeAsync(string brandingThemeId, BrandingThemeUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

brandingThemeId string

ID of the branding Theme to update

request BrandingThemeUpdateRequest

A BrandingThemeUpdateRequest containing information required for updating a BrandingTheme

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingTheme>

An updated BrandingTheme

UpdatePhoneProviderAsync(string, BrandingPhoneProviderUpdateRequest, CancellationToken)

Update a phone provider . The credentials object requires different properties depending on the email provider (which is specified using the name property).

Task<BrandingPhoneProvider> UpdatePhoneProviderAsync(string id, BrandingPhoneProviderUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

ID of the BrandingPhoneProvider to update

request BrandingPhoneProviderUpdateRequest

A BrandingPhoneProviderUpdateRequest containing the information to update

cancellationToken CancellationToken

CancellationToken

Returns

Task<BrandingPhoneProvider>

Updated BrandingPhoneProvider