From e06a8947b6ab51a2f9edf7acb4c956cbc94660cb Mon Sep 17 00:00:00 2001
From: Tim Garner <167142026+tim-garner-sp@users.noreply.github.com>
Date: Mon, 9 Dec 2024 13:34:02 -0800
Subject: [PATCH] Update doc string explaining organization name parameter

A new security check is in place that requires Auth0 tenants to opt-in when using the organization name as a parameter to the authorization flow. This commit updates the doc string to reflect this change with a link to the relevant documentation on the Auth0 website.
---
 src/global.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/global.ts b/src/global.ts
index c86d3ca20..5bd9fb5b2 100644
--- a/src/global.ts
+++ b/src/global.ts
@@ -84,6 +84,8 @@ export interface AuthorizationParams {
    *
    * - If you provide an Organization ID (a string with the prefix `org_`), it will be validated against the `org_id` claim of your user's ID Token. The validation is case-sensitive.
    * - If you provide an Organization Name (a string *without* the prefix `org_`), it will be validated against the `org_name` claim of your user's ID Token. The validation is case-insensitive.
+   *   To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard.
+   *   More information is available on the [Auth0 documentation portal](https://auth0.com/docs/manage-users/organizations/configure-organizations/use-org-name-authentication-api)
    *
    */
   organization?: string;