Class ProvidersClient

Namespace

Auth0.ManagementApi.Branding.Phone

Assembly

Auth0.ManagementApi.dll

public class ProvidersClient : IProvidersClient

Inheritance

object

ProvidersClient

Implements

IProvidersClient

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

CreateAsync(CreateBrandingPhoneProviderRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request CreateBrandingPhoneProviderRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateBrandingPhoneProviderResponseContent>

Examples

await client.Branding.Phone.Providers.CreateAsync(
    new CreateBrandingPhoneProviderRequestContent
    {
        Name = PhoneProviderNameEnum.Twilio,
        Credentials = new TwilioProviderCredentials { AuthToken = "auth_token" },
    }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete the configured phone provider.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Branding.Phone.Providers.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

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

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetBrandingPhoneProviderResponseContent>

Examples

await client.Branding.Phone.Providers.GetAsync("id");

ListAsync(ListBrandingPhoneProvidersRequestParameters, RequestOptions?, CancellationToken)

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

public WithRawResponseTask<ListBrandingPhoneProvidersResponseContent> ListAsync(ListBrandingPhoneProvidersRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListBrandingPhoneProvidersRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<ListBrandingPhoneProvidersResponseContent>

Examples

await client.Branding.Phone.Providers.ListAsync(
    new ListBrandingPhoneProvidersRequestParameters { Disabled = true }
);

TestAsync(string, CreatePhoneProviderSendTestRequestContent, RequestOptions?, CancellationToken)

public WithRawResponseTask<CreatePhoneProviderSendTestResponseContent> TestAsync(string id, CreatePhoneProviderSendTestRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request CreatePhoneProviderSendTestRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreatePhoneProviderSendTestResponseContent>

Examples

await client.Branding.Phone.Providers.TestAsync(
    "id",
    new CreatePhoneProviderSendTestRequestContent { To = "to" }
);

UpdateAsync(string, UpdateBrandingPhoneProviderRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

id string

request UpdateBrandingPhoneProviderRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateBrandingPhoneProviderResponseContent>

Examples

await client.Branding.Phone.Providers.UpdateAsync(
    "id",
    new UpdateBrandingPhoneProviderRequestContent()
);