Class DomainPasswordSettingsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainPasswordSettingsClient

Inheritance

object

DomainPasswordSettingsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainPasswordSettingsClient(string, HttpClient)

public DomainPasswordSettingsClient(string baseUrl, HttpClient httpClient)

Parameters

baseUrl string

httpClient HttpClient

Properties

BaseUrl

public string BaseUrl { get; set; }

Property Value

string

JsonSerializerSettings

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

GetAsync(CancellationToken)

Gets all password settings for the domain.

public virtual Task<PasswordSettingsResponseModel> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PasswordSettingsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PatchAsync(PasswordSettingsRequestModel, CancellationToken)

Patch the domain password settings.

public virtual Task<PasswordSettingsResponseModel> PatchAsync(PasswordSettingsRequestModel passwordSettings, CancellationToken cancellationToken = default)

Parameters

passwordSettings PasswordSettingsRequestModel

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PasswordSettingsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

protected virtual Task<DomainPasswordSettingsClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

response HttpResponseMessage

headers IReadOnlyDictionary<string, IEnumerable<string>>

cancellationToken CancellationToken

Returns

Task<DomainPasswordSettingsClient.ObjectResponseResult<T>>

Type Parameters

T