OKTA-1015295 - Rate limit doc revision

[brianduffield-okta]

Description:

• What's changed? An update and revision of the current Rate Limits documentation.
• Is this PR related to a Monolith release? n/a

Resolves:

• OKTA-1015295

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/reference/rate-limits-new/index.md	67	55	65	33	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	74	58	74	20	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	75	48	85	52	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	73	61	76	47	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	64	38	86	59	86
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	78	80	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	72	70	68	44	100

Successfully checked 7 of 7 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[eng-info-dev-github-bot]

Netlify Preview URL for the changes: https://preview-5827--reverent-murdock-829d24.netlify.app

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/reference/rate-limits-old/index.md	82	70	90	46	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	67	55	65	33	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	74	58	74	20	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	75	48	85	52	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	73	61	76	47	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	64	38	86	59	86
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	78	80	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	72	70	68	44	100

Successfully checked 8 of 8 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/reference/rate-limits-old/index.md	82	70	90	46	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	67	55	65	33	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	74	58	74	20	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	75	48	85	52	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	73	61	76	47	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	64	38	86	59	86
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	78	80	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	72	70	68	44	100

Successfully checked 8 of 8 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/reference/rate-limits-old/index.md	82	70	90	46	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	67	55	65	33	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	74	58	74	20	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	75	48	85	52	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	73	61	76	47	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	64	38	86	59	86
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	78	80	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	72	70	68	44	100

Successfully checked 8 of 8 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	67	55	65	33	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	86	72	100	46	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	85	79	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	80	86	86	55	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	86	62	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	86	100	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	85	93	86	54	100

Successfully checked 7 of 7 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	81	95	86	37	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	86	72	100	46	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	85	79	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	80	86	86	55	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	86	62	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	86	100	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	85	93	86	54	100

Successfully checked 7 of 7 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/concepts/inline-hooks/index.md	91	86	83	97	100
✅ packages/@okta/vuepress-site/docs/concepts/monitor/index.md	81	39	66	100	100
✅ packages/@okta/vuepress-site/docs/guides/hooks-best-practices/index.md	86	92	70	85	100
✅ packages/@okta/vuepress-site/docs/reference/org-defaults/index.md	80	68	76	100	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	81	95	86	37	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	86	72	100	46	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	85	79	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	80	86	86	55	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	86	62	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	86	100	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	85	93	86	54	100
✅ packages/@okta/vuepress-site/docs/reference/system-log-query/index.md	82	72	67	75	100

Successfully checked 12 of 12 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/concepts/inline-hooks/index.md	92	86	83	97	100
✅ packages/@okta/vuepress-site/docs/concepts/monitor/index.md	80	37	66	100	100
✅ packages/@okta/vuepress-site/docs/guides/hooks-best-practices/index.md	86	92	70	85	100
✅ packages/@okta/vuepress-site/docs/reference/org-defaults/index.md	79	62	76	100	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	78	82	82	39	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	86	75	100	43	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	84	74	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	82	100	85	54	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	86	62	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	81	67	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	83	83	86	54	100
✅ packages/@okta/vuepress-site/docs/reference/system-log-query/index.md	82	72	67	75	100

Successfully checked 12 of 12 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/concepts/inline-hooks/index.md	92	86	83	97	100
✅ packages/@okta/vuepress-site/docs/concepts/monitor/index.md	80	37	66	100	100
✅ packages/@okta/vuepress-site/docs/guides/hooks-best-practices/index.md	86	92	70	85	100
✅ packages/@okta/vuepress-site/docs/reference/org-defaults/index.md	81	68	86	100	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	80	90	75	48	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	86	75	100	43	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	84	74	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	82	100	85	54	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	86	62	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	81	67	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	83	83	86	54	100
✅ packages/@okta/vuepress-site/docs/reference/system-log-query/index.md	82	72	67	75	100

Successfully checked 12 of 12 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/concepts/inline-hooks/index.md	93	97	83	97	100
✅ packages/@okta/vuepress-site/docs/concepts/monitor/index.md	81	41	66	100	100
✅ packages/@okta/vuepress-site/docs/guides/hooks-best-practices/index.md	86	92	70	85	100
✅ packages/@okta/vuepress-site/docs/reference/org-defaults/index.md	86	100	86	100	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	81	95	75	48	100
✅ packages/@okta/vuepress-site/docs/reference/rl-system-log-events/index.md	89	100	80	64	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	86	75	100	43	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	88	100	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	82	100	85	54	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	88	77	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	81	67	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	83	83	86	54	100
✅ packages/@okta/vuepress-site/docs/reference/system-log-query/index.md	86	97	67	75	100

Successfully checked 13 of 13 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[aakashchandhoke-okta]

• Update section order to match what's listed on the google doc

• Rate Limit Overview section, 3rd paragraph should state - "Other, more specific buckets can be nested beneath a broader bucket and may be applicable to a subset of APIs for a subset of clients."

• Why did we change the example from /oauth2/v1/authorize to /api/v1/authorize?

• "e" is not part of code markdown for the /api/v1/users/me endpoint. Third paragraph above the "How rate limiting works section."

• Add " This ensures that authenticated users are able to call these APIs regardless of activity by other clients." to end of the same paragraph for the point directly above.

• We removed any mention of the products OWI/OCI to protect against future product name changes and refer to them as Workforce or Customer Identity.

• Remove sentence "Okta notifies all super administrators through email and other means when an org-wide rate limit is nearing its threshold. Another notification is sent when it has been exceeded." at the end of the paragraph where talking about bucket quota being influenced by several factors.

• Update point 5 of the "How rate limiting works" subsection to "Update the counters and notify, reject or allow the request. Most counters allow N requests per minute. Counters typically reset every 60 seconds, though not necessarily synchronized with wall clock minutes (e.g. a period may run from 12:00:20 to 12:01:19)"

• I see missing details on "Match requests" subsection. Can you please update?

• Make all images a bit smaller.

• Change "endpoint" to "bucket" in this sentence: "For example, if two tokens each have a 75% capacity for an endpoint with a 100 request per-minute limit..." under the "Understanding capacity allocation" subsection.

• Update Concurrency Rate Limit section to match google doc. Seeing lots of missing stuff and a table that is no longer needed.

• "Calculate your concurrency needs" section has an error for second bullet point. API calls of 250ms / 6000 calls per minute uses ~6 concurrent requests, not 25.

• Add this sentence to the end of the paragraph for "Graceful degradation and retries" - If a 429 error is received due to a concurrency limit, the System Log will show a “core.concurrency.org.limit.violation” event.

• Burst Rate Limit should be capitalized since it's a feature? Would also like to keep this definition "Okta typically allows usage above the rate limits for any buckets containing authentication and/or authorization endpoints"

• In the burst rate limit section, update the number to 601 - "a burst event at 600 requests per minute".

Taking a pause at the end of the BRL section. Will continue with a new comment after my meetings finish.

[okta-prod-github-app]

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article	Total score Required:80	Word and phrases (Brand, terms) Preferred: 80	Correctness (Spelling, grammar) Preferred: 80	Clarity (Readability) Preferred: 80	Inclusive language (+ accesibility) Preferred: 80
✅ packages/@okta/vuepress-site/docs/concepts/inline-hooks/index.md	93	97	83	97	100
✅ packages/@okta/vuepress-site/docs/concepts/monitor/index.md	81	41	66	100	100
✅ packages/@okta/vuepress-site/docs/guides/hooks-best-practices/index.md	86	92	70	85	100
✅ packages/@okta/vuepress-site/docs/reference/org-defaults/index.md	86	100	86	100	100
✅ packages/@okta/vuepress-site/docs/reference/rate-limits/index.md	78	100	71	56	100
✅ packages/@okta/vuepress-site/docs/reference/rl-system-log-events/index.md	89	100	80	64	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-burst/index.md	80	77	100	35	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-client-based/index.md	88	100	92	58	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-concurrency/index.md	76	86	68	41	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-increase/index.md	87	76	100	100	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-limits/index.md	81	67	80	50	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-monitor/index.md	83	83	86	54	100
✅ packages/@okta/vuepress-site/docs/reference/rl2-token-oauth/index.md	80	86	86	36	100
✅ packages/@okta/vuepress-site/docs/reference/system-log-query/index.md	86	97	67	75	100

Successfully checked 14 of 14 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

[brianduffield-okta]

Thanks, @aakashchandhoke-okta I've addressed the bullet points in your comment (except the images). Will update those and sync google doc on Monday.