Class DomainAssignmentsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainAssignmentsClient

Inheritance

object

DomainAssignmentsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainAssignmentsClient(string, HttpClient)

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

DeleteAsync(DeleteDomainAssignmentsModel, CancellationToken)

At most 100 assignments can be deleted at a time.
This endpoint requires bearer authentication with an Azure Active Directory token.

public virtual Task<BackgroundActivityStatus> DeleteAsync(DeleteDomainAssignmentsModel model, CancellationToken cancellationToken = default)

Parameters

model DeleteDomainAssignmentsModel

cancellationToken CancellationToken

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

Returns

Task<BackgroundActivityStatus>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(DomainAssignmentsModel, CancellationToken)

Submits many domain assignments for processing. At most 100 assignments can be submitted at a time in a batch. (Request Rate limit is 10 request per minute, so please use batching)


If assignments with the same object id/domain id already exist, they will be updated.


When a user logs in and there are multiple relevant assignments (for example, multiple groups), the one with the most powerful role wins.


This endpoint requires bearer authentication with an Azure Active Directory token.

public virtual Task<BackgroundActivityStatus> PostAsync(DomainAssignmentsModel model, CancellationToken cancellationToken = default)

Parameters

model DomainAssignmentsModel

cancellationToken CancellationToken

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

Returns

Task<BackgroundActivityStatus>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T