Deprecate accessToAllSubResources.

Authress · Sep 29, 2024 · 2031b05 · 2031b05
1 parent d8484ef
commit 2031b05
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ This is the changelog for [Authress SDK](readme.md).
 * Add explicit `clientId` into the generate service token JWT.
 * Support `AuthenticateResponse` from the `@authress/login` SDK.
 * Automatically set the `email_verified` property to be `true` for `generateUserLoginUrl`, when the user ID is an email address.
+* [Deprecate] Begin the removal of property `accessToAllSubResources` in `userPermissions.getUserResources`, recommendation: remove all references to this property.
 
 ## 2.2 ##
 * Fix `Invite` to use the correct `InviteStatement` type for `Invite` statements.

diff --git a/src/userPermissions/dtos.ts b/src/userPermissions/dtos.ts
@@ -124,6 +124,7 @@ export interface UserResources extends IPaginated<UserResources> {
    * If the user has access to all sub-resources, then instead of resources being a list, this property will be populated `true`.
    * @type {Array<UserResourcesResources>}
    * @memberof UserResources
+   * @deprecated This property will always be false in later versions. To know if a user has access to all sub-resources, either call {@link authorizerUser} or specify the {@link collectionConfiguration} as {@link collectionConfiguration.INCLUDE_NESTED}.
    */
   accessToAllSubResources?: boolean;
 }