Document toolboxDocument toolbox

migration_guide_1.x.x_to_2.x.x

Okta Resource Collector Migration Guide

Welcome to the migration guide for Resource Collector version 2.0.0! This guide will walk you through the process of updating your configuration from the old version (1.9.0) to the new version (2.0.0). The new version introduces significant improvements and changes to the configuration style to enhance performance, usability, and security.

Overview of Changes

The new configuration format introduces several key changes:

Preparing for Migration

Before starting the migration process, we recommend the following steps:

  1. Backup Your Current Configuration: Always ensure you have a backup of your existing configuration files to prevent any data loss.

  2. Review the New Configuration Documentation: Familiarize yourself with the new configuration options available in version 2.0.0.

Migration Steps

Update the Service Configuration Parameter Field Name on cloud collector

An example of the old and new configuration is shown below:

old version (<2.0.0)

"endpoint_rate_limit": { "period_in_seconds": "<rate_limit_period>", "requests_limit_in_units": "<rate_limit_calls>" }

new version (2.0.0)

"requests_limits": [ { "period": "<period_value>", "number_of_requests": "<number_of_requests>" } ]

Replace the placeholders with your required values following the description table below:

Parameter

Data type

Type

Value range / Format

Details

Parameter

Data type

Type

Value range / Format

Details

<rate_limit_period>

int

Mandatory

Minimum value: 1
Maximum value: 999

Defines the reference time period used by the rate limiter. By default uses the same Okta Basic Rate Limiter: 60 seconds.
If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:
endpoint_rate_limit:
period_in_seconds: <rate_limit_period>
requests_limit_in_units: <rate_limit_calls>

<rate_limit_calls>

int

Mandatory

Minimum value: 1
Maximum value: 99999

Defines the maximum number of calls that can be made in the rate_limit_period. Check in Okta site your limits per endpoint based on your Okta tier.
If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:
endpoint_rate_limit:
period_in_seconds: <rate_limit_period>
requests_limit_in_units: <rate_limit_calls>

Update the Service Configuration Parameter Field Name On Premise Collector

old version (<2.0.0)

endpoint_rate_limit: period_in_seconds: <rate_limit_period> requests_limit_in_units: <rate_limit_calls>

new version (2.0.0)

Replace the placeholders with your required values following the description table below:

Parameter

Data type

Type

Value range / Format

Details

Parameter

Data type

Type

Value range / Format

Details

<rate_limit_period>

int

Mandatory

Minimum value: 1
Maximum value: 999

Defines the reference time period used by the rate limiter. By default uses the same Okta Basic Rate Limiter: 60 seconds.
If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:
endpoint_rate_limit:
period_in_seconds: <rate_limit_period>
requests_limit_in_units: <rate_limit_calls>

<rate_limit_calls>

int

Mandatory

Minimum value: 1
Maximum value: 99999

Defines the maximum number of calls that can be made in the rate_limit_period. Check in Okta site your limits per endpoint based on your Okta tier.
If you do not need this feature (Local Rate Limiter), remove the following definition from the service/endpoint:
endpoint_rate_limit:
period_in_seconds: <rate_limit_period>
requests_limit_in_units: <rate_limit_calls>