Interface ITenantSettingsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public interface ITenantSettingsClient

Methods

GetAsync(string, bool, CancellationToken)

Gets the settings for the tenant.

Task<TenantSettings> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = default)

Parameters

fields string

A comma-separated list of fields to include or exclude (depending on includeFields) from the result, empty to retrieve all fields.

includeFields bool

true if the fields specified are to be included in the result, false otherwise (defaults to true).

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<TenantSettings>

A TenantSettings containing the settings for the tenant.

UpdateAsync(TenantSettingsUpdateRequest, CancellationToken)

Updates the settings for the tenant.

Task<TenantSettings> UpdateAsync(TenantSettingsUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request TenantSettingsUpdateRequest

TenantSettingsUpdateRequest containing the settings for the tenant which are to be updated.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<TenantSettings>

A TenantSettings containing the updated settings for the tenant.