Class NetworkAclClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods for managing Network Access Control Lists (ACLs) in Auth0.

public class NetworkAclClient : BaseClient, INetworkAclClient

Inheritance

object

BaseClient

NetworkAclClient

Implements

INetworkAclClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.BuildUri(string, IList<Tuple<string, string>>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NetworkAclClient(IManagementConnection, Uri, IDictionary<string, string>)

Creates a new instance of the NetworkAclClient class.

public NetworkAclClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

baseUri Uri

defaultHeaders IDictionary<string, string>

Methods

CreateAsync(NetworkAclCreateRequest, CancellationToken)

Create a new access control list for your client.

public Task CreateAsync(NetworkAclCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request NetworkAclCreateRequest

NetworkAclCreateRequest class containing all information required to create the ACL entry

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

DeleteAsync(string, CancellationToken)

Delete existing access control list for your client.

public Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the ACL to delete.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

GetAllAsync(PaginationInfo?, CancellationToken)

Get all access control list entries for your client.

public Task<IPagedList<NetworkAclEntry>> GetAllAsync(PaginationInfo? pagination = null, CancellationToken cancellationToken = default)

Parameters

pagination PaginationInfo

Specifies pagination info to use when requesting paged results.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<IPagedList<NetworkAclEntry>>

An IPagedList<T> containing the Access Control List.

GetAsync(string, CancellationToken)

Get a specific access control list entry for your client.

public Task<NetworkAclEntry> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the access control list to retrieve.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<NetworkAclEntry>

An NetworkAclEntry containing the Access Control List.

UpdateAsync(string, NetworkAclPatchUpdateRequest, CancellationToken)

Update existing access control list for your client.

public Task<NetworkAclEntry> UpdateAsync(string id, NetworkAclPatchUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the ACL to update.

request NetworkAclPatchUpdateRequest

NetworkAclPatchUpdateRequest containing information to update

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<NetworkAclEntry>

UpdateAsync(string, NetworkAclPutUpdateRequest, CancellationToken)

Update existing access control list for your client.

public Task<NetworkAclEntry> UpdateAsync(string id, NetworkAclPutUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the ACL to update.

request NetworkAclPutUpdateRequest

NetworkAclPutUpdateRequest containing information to update

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<NetworkAclEntry>