Skip to content

Commit

Permalink
Update doc string explaining organization name parameter
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tim-garner-sp authored Dec 9, 2024
1 parent f2e5668 commit e06a894
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/global.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit e06a894

Please sign in to comment.