Interface INetworkZonesClient
A client that works with Okta NetworkZone resources.
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public interface INetworkZonesClient
Methods
ActivateNetworkZoneAsync(String, CancellationToken)
Activate Network Zone
Declaration
Task<INetworkZone> ActivateNetworkZoneAsync(string zoneId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | zoneId | |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<INetworkZone> | The INetworkZone response. |
CreateNetworkZoneAsync(INetworkZone, CancellationToken)
Adds a new network zone to your Okta organization.
Declaration
Task<INetworkZone> CreateNetworkZoneAsync(INetworkZone zone, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
INetworkZone | zone | The INetworkZone resource. |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<INetworkZone> | The INetworkZone response. |
DeactivateNetworkZoneAsync(String, CancellationToken)
Deactivates a network zone.
Declaration
Task<INetworkZone> DeactivateNetworkZoneAsync(string zoneId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | zoneId | |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<INetworkZone> | The INetworkZone response. |
DeleteNetworkZoneAsync(String, CancellationToken)
Removes network zone.
Declaration
Task DeleteNetworkZoneAsync(string zoneId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | zoneId | |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
GetNetworkZoneAsync(String, CancellationToken)
Fetches a network zone from your Okta organization by id
.
Declaration
Task<INetworkZone> GetNetworkZoneAsync(string zoneId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | zoneId | |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<INetworkZone> | The INetworkZone response. |
ListNetworkZones(String, Nullable<Int32>, String)
Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.
Declaration
ICollectionClient<INetworkZone> ListNetworkZones(string after = null, int? limit, string filter = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | after | Specifies the pagination cursor for the next page of network zones |
System.Nullable<System.Int32> | limit | Specifies the number of results for a page |
System.String | filter | Filters zones by usage or id expression |
Returns
Type | Description |
---|---|
ICollectionClient<INetworkZone> | A collection of INetworkZone that can be enumerated asynchronously. |
UpdateNetworkZoneAsync(INetworkZone, String, CancellationToken)
Updates a network zone in your organization.
Declaration
Task<INetworkZone> UpdateNetworkZoneAsync(INetworkZone zone, string zoneId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
INetworkZone | zone | The INetworkZone resource. |
System.String | zoneId | |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<INetworkZone> | The INetworkZone response. |