Okta.PowerShell.Okta.PowerShell\Api.OktaNetworkZoneApi

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
Invoke-OktaActivateNetworkZone	POST /api/v1/zones/{zoneId}/lifecycle/activate	Activate a Network Zone
New-OktaNetworkZone	POST /api/v1/zones	Create a Network Zone
Invoke-OktaDeactivateNetworkZone	POST /api/v1/zones/{zoneId}/lifecycle/deactivate	Deactivate a Network Zone
Invoke-OktaDeleteNetworkZone	DELETE /api/v1/zones/{zoneId}	Delete a Network Zone
Get-OktaNetworkZone	GET /api/v1/zones/{zoneId}	Retrieve a Network Zone
Invoke-OktaListNetworkZones	GET /api/v1/zones	List all Network Zones
Update-OktaNetworkZone	PUT /api/v1/zones/{zoneId}	Replace a Network Zone

Invoke-OktaActivateNetworkZone

NetworkZone Invoke-OktaActivateNetworkZone
[-ZoneId]

Activate a Network Zone

Activate Network Zone

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$ZoneId = "MyZoneId" # String | 

# Activate a Network Zone
try {
    $Result = Invoke-OktaActivateNetworkZone -ZoneId $ZoneId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaActivateNetworkZone: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
ZoneId	String

Return type

NetworkZone (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

New-OktaNetworkZone

NetworkZone New-OktaNetworkZone
[-Zone]

Create a Network Zone

Adds a new network zone to your Okta organization.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$NetworkZoneAddress = Initialize-NetworkZoneAddress -Type "CIDR" -Value "MyValue"
$NetworkZoneLocation = Initialize-NetworkZoneLocation -Country "MyCountry" -Region "MyRegion"
$NetworkZone = Initialize-NetworkZone -Asns "MyAsns" -Created (Get-Date) -Gateways $NetworkZoneAddress -Id "MyId" -LastUpdated (Get-Date) -Locations $NetworkZoneLocation -Name "MyName" -Proxies $NetworkZoneAddress -ProxyType "MyProxyType" -Status "ACTIVE" -System $false -Type "DYNAMIC" -Usage "BLOCKLIST" -Links @{ key_example =  } # NetworkZone | 

# Create a Network Zone
try {
    $Result = New-OktaNetworkZone -Zone $Zone
} catch {
    Write-Host ("Exception occurred when calling New-OktaNetworkZone: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Zone	NetworkZone

Return type

NetworkZone (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeactivateNetworkZone

NetworkZone Invoke-OktaDeactivateNetworkZone
[-ZoneId]

Deactivate a Network Zone

Deactivates a network zone.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$ZoneId = "MyZoneId" # String | 

# Deactivate a Network Zone
try {
    $Result = Invoke-OktaDeactivateNetworkZone -ZoneId $ZoneId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeactivateNetworkZone: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
ZoneId	String

Return type

NetworkZone (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteNetworkZone

void Invoke-OktaDeleteNetworkZone
[-ZoneId]

Delete a Network Zone

Removes network zone.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$ZoneId = "MyZoneId" # String | 

# Delete a Network Zone
try {
    $Result = Invoke-OktaDeleteNetworkZone -ZoneId $ZoneId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteNetworkZone: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
ZoneId	String

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaNetworkZone

NetworkZone Get-OktaNetworkZone
[-ZoneId]

Retrieve a Network Zone

Fetches a network zone from your Okta organization by id.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$ZoneId = "MyZoneId" # String | 

# Retrieve a Network Zone
try {
    $Result = Get-OktaNetworkZone -ZoneId $ZoneId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaNetworkZone: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
ZoneId	String

Return type

NetworkZone (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListNetworkZones

NetworkZone[] Invoke-OktaListNetworkZones
        [-After]
        [-Limit] <System.Nullable[Int32]>
        [-Filter]

List all Network Zones

Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$After = "MyAfter" # String | Specifies the pagination cursor for the next page of network zones (optional)
$Limit = 56 # Int32 | Specifies the number of results for a page (optional) (default to -1)
$Filter = "MyFilter" # String | Filters zones by usage or id expression (optional)

# List all Network Zones
try {
    $Result = Invoke-OktaListNetworkZones -After $After -Limit $Limit -Filter $Filter
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListNetworkZones: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
After	String	Specifies the pagination cursor for the next page of network zones	[optional]
Limit	Int32	Specifies the number of results for a page	[optional] [default to -1]
Filter	String	Filters zones by usage or id expression	[optional]

Return type

NetworkZone[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-OktaNetworkZone

NetworkZone Update-OktaNetworkZone
[-ZoneId]
[-Zone]

Replace a Network Zone

Updates a network zone in your organization.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$ZoneId = "MyZoneId" # String | 
$NetworkZoneAddress = Initialize-NetworkZoneAddress -Type "CIDR" -Value "MyValue"
$NetworkZoneLocation = Initialize-NetworkZoneLocation -Country "MyCountry" -Region "MyRegion"
$NetworkZone = Initialize-NetworkZone -Asns "MyAsns" -Created (Get-Date) -Gateways $NetworkZoneAddress -Id "MyId" -LastUpdated (Get-Date) -Locations $NetworkZoneLocation -Name "MyName" -Proxies $NetworkZoneAddress -ProxyType "MyProxyType" -Status "ACTIVE" -System $false -Type "DYNAMIC" -Usage "BLOCKLIST" -Links @{ key_example =  } # NetworkZone | 

# Replace a Network Zone
try {
    $Result = Update-OktaNetworkZone -ZoneId $ZoneId -Zone $Zone
} catch {
    Write-Host ("Exception occurred when calling Update-OktaNetworkZone: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
ZoneId	String
Zone	NetworkZone

Return type

NetworkZone (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OktaNetworkZoneApi.md

Latest commit

History

OktaNetworkZoneApi.md

File metadata and controls

Okta.PowerShell.Okta.PowerShell\Api.OktaNetworkZoneApi

Invoke-OktaActivateNetworkZone

Example

Parameters

Return type

Authorization

HTTP request headers

New-OktaNetworkZone

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeactivateNetworkZone

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteNetworkZone

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaNetworkZone

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaListNetworkZones

Example

Parameters

Return type

Authorization

HTTP request headers

Update-OktaNetworkZone

Example

Parameters

Return type

Authorization

HTTP request headers