Skip to content

Commit 4f4e893

Browse files
OKTA-610875 Deprecate Zones API VuePress Reference (#4160)
* deprecate zones api and link updates * Update packages/@okta/vuepress-site/docs/reference/api/zones/index.md Co-authored-by: vanngo-okta <80703015+vanngo-okta@users.noreply.github.com> --------- Co-authored-by: vanngo-okta <80703015+vanngo-okta@users.noreply.github.com>
1 parent f4dc5db commit 4f4e893

File tree

11 files changed

+25
-18
lines changed

11 files changed

+25
-18
lines changed

packages/@okta/vuepress-site/conductor.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ redirects:
496496
- from: /docs/api/resources/users/index.html
497497
to: /docs/reference/api/users/
498498
- from: /docs/api/resources/zones/index.html
499-
to: /docs/reference/api/zones/
499+
to: https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/
500500
- from: /docs/how-to/add-user-consent-to-flow/index.html
501501
to: /docs/guides/request-user-consent/
502502
- from: /docs/how-to/byo_saml/index.html
@@ -802,7 +802,7 @@ redirects:
802802
- from: /docs/api/resources/users
803803
to: /docs/reference/api/users/
804804
- from: /docs/api/resources/zones
805-
to: /docs/reference/api/zones/
805+
to: https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/
806806
- from: /docs/api/resources/social_authentication
807807
to: /docs/guides/social-login/
808808
- from: /docs/api/resources/social_authentication/index.html
@@ -900,7 +900,7 @@ redirects:
900900
- from: /docs/api/resources/trusted-origins.html
901901
to: /docs/reference/api/trusted-origins/
902902
- from: /docs/api/resources/zones.html
903-
to: /docs/reference/api/zones/
903+
to: https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/
904904
- from: /guides/add-saml-idp/-/configure-oidc-client/index.html
905905
to: /docs/guides/add-saml-idp/-/configure-oidc-client/
906906
- from: /guides/add-saml-idp/-/configure-saml-idp/index.html

packages/@okta/vuepress-site/docs/guides/archive-configure-signon-policy/main/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The following are step-by-step instructions to configure an Okta sign-on policy
6767

6868
3. For this use case example, leave the default of **Anywhere** in the **If User's IP is** drop-down box. For other use cases where you want to assign location parameters, you can specify what kind of location prompts authentication, for example, prompting a user for a factor when they aren't on the corporate network.
6969

70-
> **Note:** You can click the **Networks** link to access the gateway settings that enable your choice of access. A [network zone](https://help.okta.com/okta_help.htm?id=ext_Security_Network) is a security perimeter used to limit or restrict access to a network based on a single IP address, one or more IP address ranges, or a list of geolocations. You can also create networks zones using the [Zone API](/docs/reference/api/zones/).
70+
> **Note:** You can click the **Networks** link to access the gateway settings that enable your choice of access. A [network zone](https://help.okta.com/okta_help.htm?id=ext_Security_Network) is a security perimeter used to limit or restrict access to a network based on a single IP address, one or more IP address ranges, or a list of geolocations. You can also create networks zones using the [Zone API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/).
7171
7272
4. Leave the default of **Any** in the **And Authenticates via** drop-down box.
7373

packages/@okta/vuepress-site/docs/guides/configure-signon-policy/main/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ The following are step-by-step instructions to configure another rule for the de
130130

131131
4. Configure IF conditions to define the authentication context for the rule. Select **Not in any of the following zones** from the **AND User’s IP is** dropdown list.
132132

133-
> **Note:** You can click the **Go to Network Zones** link to access the gateway settings that enable your choice of access. A [network zone](https://help.okta.com/okta_help.htm?id=ext_Security_Network) is a security perimeter used to limit or restrict access to a network based on a single IP address, one or more IP address ranges, or a list of geolocations. You can also create network zones using the [Zones API](/docs/reference/api/zones/).
133+
> **Note:** You can click the **Go to Network Zones** link to access the gateway settings that enable your choice of access. A [network zone](https://help.okta.com/okta_help.htm?id=ext_Security_Network) is a security perimeter used to limit or restrict access to a network based on a single IP address, one or more IP address ranges, or a list of geolocations. You can also create network zones using the [Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/).
134134
135135
5. In the text box, start typing the dynamic zone name and then select it when it appears in the list.
136136

packages/@okta/vuepress-site/docs/reference/api/policy/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1061,7 +1061,7 @@ Specifies an authentication entry point
10611061
10621062
#### Network Condition object
10631063

1064-
Specifies a network selection mode and a set of network zones to be included or excluded. If the connection parameter's data type is `ZONE`, one of the include or exclude arrays is required. Specific zone IDs to include or exclude are enumerated in the respective arrays. You can use the [Zones API](/docs/reference/api/zones/) to manage network zones.
1064+
Specifies a network selection mode and a set of network zones to be included or excluded. If the connection parameter's data type is `ZONE`, one of the include or exclude arrays is required. Specific zone IDs to include or exclude are enumerated in the respective arrays. You can use the [Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) to manage network zones.
10651065

10661066
| Parameter | Description | Data Type | Required |
10671067
| --------- | ---------------------- | ------------------ | -------------------------------------- |

packages/@okta/vuepress-site/docs/reference/api/system-log/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ When an event is triggered by an HTTP request, the client object describes the [
270270
| id | For OAuth requests, this is the ID of the OAuth [client](https://tools.ietf.org/html/rfc6749#section-1.1) making the request. For SSWS token requests, this is the ID of the agent making the request. | String | TRUE |
271271
| userAgent | The [user agent](https://en.wikipedia.org/wiki/User_agent) that is used by an actor to perform an action | [UserAgent object](#useragent-object) | TRUE |
272272
| geographicalContext | The physical location where the client is making its request from | [GeographicalContext object](#geographicalcontext-object) | TRUE |
273-
| zone | The `name` of the [Zone](/docs/reference/api/zones/#ZoneModel) that the client's location is mapped to | String | TRUE |
273+
| zone | The `name` of the [Zone](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/#tag/NetworkZone/operation/getNetworkZone) that the client's location is mapped to | String | TRUE |
274274
| ipAddress | IP address that the client is making its request from | String | TRUE |
275275
| device | Type of device that the client operates from (for example, Computer) | String | TRUE |
276276

packages/@okta/vuepress-site/docs/reference/api/threat-insight/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In order to prevent abuse, Okta ThreatInsight works in a limited capacity for fr
1414
| Field Name | Description | Data Type | Required | Max Length |
1515
| :------------- | :------------------------------------------------------------------ | :-------------------------------------------- | :------------ | :------------ |
1616
| action | Specifies how Okta responds to authentication requests from suspicious IPs. Values are none, audit, or block. A value of none indicates that ThreatInsight is disabled. A value of audit indicates that Okta logs suspicious requests in the System Log. A value of block indicates that Okta logs suspicious requests in the System Log and blocks the requests. | String | Yes | N/A |
17-
| excludeZones | Accepts a list of [Network Zone](/docs/reference/api/zones/) IDs. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. | List | No | N/A |
17+
| excludeZones | Accepts a list of [Network Zone](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) IDs. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. | List | No | N/A |
1818

1919

2020
## ThreatInsight configuration API operations

packages/@okta/vuepress-site/docs/reference/api/zones/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ category: management
44
---
55
# Zones API
66

7+
The Zones API reference is now available at the new [Okta API reference portal](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) as the Network Zones API.
8+
9+
Explore the [Okta Public API Collections](https://www.postman.com/okta-eng/workspace/okta-public-api-collections/overview) workspace to get started with the Network Zones API Postman collection.
10+
11+
12+
<!-- {api content}
713
The Okta Zones API provides operations to manage Zones in your organization. There are two usage Zone types: Policy Network Zones and Blocklist Network Zones. Policy Network Zones are used to guide policy decisions. Blocklist Network Zones are used to deny access from certain IP addresses, locations, proxy types, or Autonomous System Numbers (ASNs) before policy evaluation.
814
915
A default system Policy Network Zone is provided in your Okta org. You can use the Zones API to modify the default Policy Network Zone or to create a custom Policy or Blocklist Network Zone. When you create your custom Zone, you can specify if the Zone is an IP Zone or a Dynamic Zone. An IP Zone allows you to define network perimeters around a set of IPs, whereas a Dynamic Zone allows you to define network perimeters around location, IP type, and ASNs.
@@ -886,3 +892,4 @@ curl -X PUT \
886892
}
887893
}
888894
```
895+
-->

packages/@okta/vuepress-site/docs/release-notes/2017/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ This parameter allows you to force the validation of the password policy's `minA
6969

7070
The following bug fixes will be available on preview orgs starting Dec 13, 2017, and will be available on production orgs starting December 19, 2017:
7171

72-
* When using the [Zones API](/docs/reference/api/zones/#update-a-network-zone), erasing all IP addresses in the Default IP Blocklist zone caused an error. (OKTA-145602)
72+
* When using the [Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/#tag/NetworkZone/operation/replaceNetworkZone), erasing all IP addresses in the Default IP Blocklist zone caused an error. (OKTA-145602)
7373

7474

7575
## 2017.49
@@ -483,7 +483,7 @@ Dates for preview and production release are the earliest possible release date.
483483

484484
Zones are used to group IP Address ranges so that policy decisions can be made based on the client's IP location.
485485

486-
[The Zones API](/docs/reference/api/zones/) is an <ApiLifecycle access="ea" /> release. Contact [Support](https://support.okta.com/help/open_case) to enable it.
486+
[The Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) is an <ApiLifecycle access="ea" /> release. Contact [Support](https://support.okta.com/help/open_case) to enable it.
487487
This API can be enabled beginning August 22, 2017 for preview orgs, and beginning September 5, 2017 for production orgs.
488488

489489
### API Bug Fix
@@ -529,7 +529,7 @@ You can also create an OpenID Connect app more easily with this simplified flow:
529529

530530
Zones are used to group IP Address ranges so that policy decisions can be made based on the client's IP location.
531531

532-
[The Zones API](/docs/reference/api/zones/) is an <ApiLifecycle access="ea" /> release. Contact [Support](https://support.okta.com/help/open_case) to enable it.
532+
[The Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) is an <ApiLifecycle access="ea" /> release. Contact [Support](https://support.okta.com/help/open_case) to enable it.
533533
This API can be enabled beginning August 22, 2017 for preview orgs, and beginning September 5, 2017 for production orgs.
534534

535535
### API Bug Fixes
@@ -1577,7 +1577,7 @@ The Zones API is now Generally Available in preview orgs. It will be at least on
15771577
15781578
Zones are used to group IP Address ranges so that policy decisions can be made based on the zone a client's IP belongs to.
15791579
1580-
For more information, see [the Zones API developer documentation](/docs/reference/api/zones/).
1580+
For more information, see [the Zones API developer documentation](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/).
15811581
15821582
> Update: Zones API is [a Beta release](/docs/reference/releases-at-okta/). This release note is in error.
15831583
@@ -1980,7 +1980,7 @@ Instead, Okta will send a customer communication explaining the migration path t
19801980
19811981
### Platform Feature Improvement: Zones API Generally Available in Preview
19821982
1983-
Access policies can now be defined based on an IP address range using [the Zones API](/docs/reference/api/zones/).
1983+
Access policies can now be defined based on an IP address range using [the Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/).
19841984
This feature is Generally Available in preview orgs for at least one month before being Generally Available in production. <!-- OKTA-121280 -->
19851985
19861986
### Platform Bugs Fixed

packages/@okta/vuepress-site/docs/release-notes/2018/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ The following features have already been released as Early Access. To enable the
253253

254254
#### Bugs Fixed in 2018.40
255255

256-
* Responses from the `/zones` [endpoint](/docs/reference/api/zones/#zones-api) included a duplicate of the `type` field. (OKTA-188605)
256+
* Responses from the `/zones` [endpoint](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) included a duplicate of the `type` field. (OKTA-188605)
257257
* The `/idps/credentials/keys` [endpoint](/docs/reference/api/idps/#add-x509-certificate-public-key) was requiring requests to include extra parameters. (OKTA-189780)
258258

259259
#### Previously Released Early Access Features 2018.40 Update
@@ -525,7 +525,7 @@ The following features have already been released as Early Access. To enable the
525525

526526
#### Bugs Fixed in 2018.29
527527

528-
* Using the [Zones API](/docs/reference/api/zones/) to modify an existing zone that is blocked, removed the zone from the blocklist and converted it to a normal IP Zone. (OKTA-176610)
528+
* Using the [Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) to modify an existing zone that is blocked, removed the zone from the blocklist and converted it to a normal IP Zone. (OKTA-176610)
529529
* Using the [Applications API](/docs/reference/api/apps/) to create an OAuth client caused an error if the `credentials.oauthClient` property was not provided, even though it is not required. (OKTA-179275)
530530
* The System Log CSV report did not contain a value for `AuthenticationContext.issuer` for the event type `user.authentication.authenticate`. (OKTA-147165)
531531

@@ -591,7 +591,7 @@ The [System Log API](/docs/reference/api/system-log/) is now Generally Available
591591
#### Bugs Fixed in 2018.27
592592

593593
* Users who clicked an Activation Link for an [Okta Verify factor](/docs/reference/api/factors/#activate-push-factor) that had already been activated would get back an HTTP 500 error. (OKTA-146511)
594-
* Attempting to add more than the maximum number of zones via the [Zones API](/docs/reference/api/zones/) would result in an HTTP 500 error. (OKTA-175991)
594+
* Attempting to add more than the maximum number of zones via the [Zones API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) would result in an HTTP 500 error. (OKTA-175991)
595595

596596
#### Previously Released Early Access Features 2018.27 Update
597597

packages/@okta/vuepress-site/docs/release-notes/2019/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ The Okta Mappings API provides operations to manage the mapping of properties be
351351

352352
#### Missing type property now returns a 400 error code
353353

354-
If you create an [IP network zone](/docs/reference/api/zones/#ip-zone-properties) without a `type` property for an IP field, PUT or POST requests made to the Zone API now return a 400 error code. <!-- OKTA-239170 -->
354+
If you create an [IP network zone](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/NetworkZone/) without a `type` property for an IP field, PUT or POST requests made to the Zone API now return a 400 error code. <!-- OKTA-239170 -->
355355

356356
#### Bug Fixed in 2019.08.0
357357

0 commit comments

Comments
 (0)