Class DomainLocalUsersClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainLocalUsersClient

Inheritance

object

DomainLocalUsersClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainLocalUsersClient(string, HttpClient)

public DomainLocalUsersClient(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

ChangePasswordV2Async(string, ChangePasswordLocalUserRequestModel, CancellationToken)

Edits local user password.

public virtual Task<ChangePasswordLocalUserResponseModel> ChangePasswordV2Async(string identityId, ChangePasswordLocalUserRequestModel model, CancellationToken cancellationToken = default)

Parameters

identityId string

model ChangePasswordLocalUserRequestModel

cancellationToken CancellationToken

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

Returns

Task<ChangePasswordLocalUserResponseModel>

Success

Exceptions

NfieldSdkException

A server side error occurred.

DeleteAsync(string, CancellationToken)

Deletes a user

public virtual Task DeleteAsync(string identityId, CancellationToken cancellationToken = default)

Parameters

identityId string

cancellationToken CancellationToken

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

Returns

Task

Success

Exceptions

NfieldSdkException

A server side error occurred.

GetAllAsync(CancellationToken)

Returns a list of all local users.

public virtual Task<ICollection<LocalUserResponseModel>> GetAllAsync(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<ICollection<LocalUserResponseModel>>

Success

Exceptions

NfieldSdkException

A server side error occurred.

GetAsync(string, CancellationToken)

Returns details for a local user.

public virtual Task<LocalUserResponseModel> GetAsync(string identityId, CancellationToken cancellationToken = default)

Parameters

identityId string

cancellationToken CancellationToken

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

Returns

Task<LocalUserResponseModel>

Success

Exceptions

NfieldSdkException

A server side error occurred.

PatchAsync(string, EditLocalUserRequestModel, CancellationToken)

Edits properties of a local user.

public virtual Task<LocalUserResponseModel> PatchAsync(string identityId, EditLocalUserRequestModel model, CancellationToken cancellationToken = default)

Parameters

identityId string

model EditLocalUserRequestModel

cancellationToken CancellationToken

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

Returns

Task<LocalUserResponseModel>

Success

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(LocalUserRequestModel, CancellationToken)

Creates a new user.

public virtual Task<LocalUserResponseModel> PostAsync(LocalUserRequestModel model, CancellationToken cancellationToken = default)

Parameters

model LocalUserRequestModel

cancellationToken CancellationToken

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

Returns

Task<LocalUserResponseModel>

Success

Exceptions

NfieldSdkException

A server side error occurred.

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

protected virtual Task<DomainLocalUsersClient.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<DomainLocalUsersClient.ObjectResponseResult<T>>

Type Parameters

T