feat: add optional scope parameter to clearApiCredentials (#1412)

Author: subhankarmaiti

EXAMPLES.md

@@ -492,6 +492,9 @@ function MyComponent() {
   const clearFirstApiCache = async () => {
     // Clear cached credentials for a specific API
     await clearApiCredentials('https://first-api.example.com');
+
+    // Or clear with specific scope
+    await clearApiCredentials('https://first-api.example.com', 'read:data');
   };
 
   return (
@@ -531,6 +534,12 @@ console.log('Scope:', apiCredentials.scope);
 await auth0.credentialsManager.clearApiCredentials(
   'https://first-api.example.com'
 );
+
+// Clear with specific scope
+await auth0.credentialsManager.clearApiCredentials(
+  'https://first-api.example.com',
+  'read:data write:data'
+);
 ```
 
 ### Web Platform Configuration

android/src/main/java/com/auth0/react/A0Auth0Module.kt

@@ -328,8 +328,8 @@ class A0Auth0Module(private val reactContext: ReactApplicationContext) : A0Auth0
     }
 
     @ReactMethod
-    override fun clearApiCredentials(audience: String, promise: Promise) {
-        secureCredentialsManager.clearApiCredentials(audience)
+    override fun clearApiCredentials(audience: String, scope: String?, promise: Promise) {
+        secureCredentialsManager.clearApiCredentials(audience, scope)
         promise.resolve(true)
     }
 

android/src/main/oldarch/com/auth0/react/A0Auth0Spec.kt

@@ -63,7 +63,7 @@ abstract class A0Auth0Spec(context: ReactApplicationContext) : ReactContextBaseJ
 
     @ReactMethod
     @DoNotStrip
-    abstract fun clearApiCredentials(audience: String, promise: Promise)
+    abstract fun clearApiCredentials(audience: String, scope: String?, promise: Promise)
 
     @ReactMethod
     @DoNotStrip

ios/A0Auth0.mm

@@ -87,9 +87,10 @@ - (dispatch_queue_t)methodQueue
 }
 
 RCT_EXPORT_METHOD(clearApiCredentials: (NSString *)audience
+                  scope:(NSString * _Nullable)scope
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject) {
-    [self.nativeBridge clearApiCredentialsWithAudience:audience resolve:resolve reject:reject];
+    [self.nativeBridge clearApiCredentialsWithAudience:audience scope:scope resolve:resolve reject:reject];
 }
 
 

ios/NativeBridge.swift

@@ -372,10 +372,10 @@ public class NativeBridge: NSObject {
     }
 
 
-    @objc public func clearApiCredentials(audience: String, resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) {
-        // The clear(forAudience:) method returns a boolean indicating success.
+    @objc public func clearApiCredentials(audience: String, scope: String?, resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) {
+        // The clear(forAudience:scope:) method returns a boolean indicating success.
         // We can resolve the promise with this boolean value.
-        resolve(credentialsManager.clear(forAudience: audience))
+        resolve(credentialsManager.clear(forAudience: audience, scope: scope))
     }
 
     @objc public func getClientId() -> String {

src/core/interfaces/ICredentialsManager.ts

@@ -136,18 +136,24 @@ export interface ICredentialsManager {
 
   /**
    * Removes cached credentials for a specific audience.
+   * Optionally filter by scope to clear only specific scope-based credentials.
    *
    * This clears the stored API credentials for the given audience, forcing the next
    * `getApiCredentials` call for this audience to perform a fresh token exchange.
    *
    * @param audience The identifier of the API for which to clear credentials.
+   * @param scope Optional scope to clear. If credentials were fetched with a scope, it is recommended to pass the same scope when clearing them.
    * @returns A promise that resolves when the credentials are cleared.
    * @throws {CredentialsManagerError} If the operation fails.
    *
    * @example
    * ```typescript
+   * // Clear all credentials for an audience
    * await credentialsManager.clearApiCredentials('https://api.example.com');
+   *
+   * // Clear credentials for specific scope (recommended)
+   * await credentialsManager.clearApiCredentials('https://api.example.com', 'read:data');
    * ```
    */
-  clearApiCredentials(audience: string): Promise<void>;
+  clearApiCredentials(audience: string, scope?: string): Promise<void>;
 }

src/platforms/native/adapters/NativeCredentialsManager.ts

@@ -40,21 +40,12 @@ export class NativeCredentialsManager implements ICredentialsManager {
     );
   }
 
-  hasValidCredentials(minTtl?: number): Promise<boolean> {
-    return this.handleError(this.bridge.hasValidCredentials(minTtl));
+  async clearCredentials(): Promise<void> {
+    return this.handleError(this.bridge.clearCredentials());
   }
 
-  async clearCredentials(): Promise<void> {
-    await this.handleError(this.bridge.clearCredentials());
-    // Also clear the DPoP key when clearing credentials
-    // Ignore errors from DPoP key clearing - this matches iOS behavior
-    // where we log the error but don't fail the operation
-    try {
-      await this.bridge.clearDPoPKey();
-    } catch {
-      // Silently ignore DPoP key clearing errors
-      // The main credentials are already cleared at this point
-    }
+  async hasValidCredentials(minTtl?: number): Promise<boolean> {
+    return this.handleError(this.bridge.hasValidCredentials(minTtl));
   }
 
   async getApiCredentials(
@@ -70,8 +61,8 @@ export class NativeCredentialsManager implements ICredentialsManager {
     return new ApiCredentials(nativeCredentials as IApiCredentials);
   }
 
-  clearApiCredentials(audience: string): Promise<void> {
-    return this.handleError(this.bridge.clearApiCredentials(audience));
+  async clearApiCredentials(audience: string, scope?: string): Promise<void> {
+    return this.handleError(this.bridge.clearApiCredentials(audience, scope));
   }
 
   getSSOCredentials(

src/platforms/native/adapters/__tests__/NativeCredentialsManager.spec.ts

@@ -357,15 +357,54 @@ describe('NativeCredentialsManager', () => {
       ).rejects.toThrow(CredentialsManagerError);
     });
 
-    it('should clear credentials on success', async () => {
+    it('should clear credentials for audience without scope', async () => {
       mockBridge.clearApiCredentials.mockResolvedValue(undefined);
 
       await expect(
         manager.clearApiCredentials('https://api.example.com')
       ).resolves.toBeUndefined();
 
       expect(mockBridge.clearApiCredentials).toHaveBeenCalledWith(
-        'https://api.example.com'
+        'https://api.example.com',
+        undefined
+      );
+    });
+
+    it('should clear credentials for audience with scope', async () => {
+      mockBridge.clearApiCredentials.mockResolvedValue(undefined);
+
+      await expect(
+        manager.clearApiCredentials(
+          'https://api.example.com',
+          'read:data write:data'
+        )
+      ).resolves.toBeUndefined();
+
+      expect(mockBridge.clearApiCredentials).toHaveBeenCalledWith(
+        'https://api.example.com',
+        'read:data write:data'
+      );
+    });
+
+    it('should handle multiple different audiences', async () => {
+      mockBridge.clearApiCredentials.mockResolvedValue(undefined);
+
+      await manager.clearApiCredentials('https://api1.example.com');
+      await manager.clearApiCredentials(
+        'https://api2.example.com',
+        'admin:write'
+      );
+
+      expect(mockBridge.clearApiCredentials).toHaveBeenCalledTimes(2);
+      expect(mockBridge.clearApiCredentials).toHaveBeenNthCalledWith(
+        1,
+        'https://api1.example.com',
+        undefined
+      );
+      expect(mockBridge.clearApiCredentials).toHaveBeenNthCalledWith(
+        2,
+        'https://api2.example.com',
+        'admin:write'
       );
     });
   });

src/platforms/native/bridge/INativeBridge.ts

@@ -123,7 +123,15 @@ export interface INativeBridge {
     parameters?: object
   ): Promise<ApiCredentials>;
 
-  clearApiCredentials(audience: string): Promise<void>;
+  /**
+   * Clears API credentials for a specific audience from secure storage.
+   * Optionally filter by scope to clear only specific scope-based credentials.
+   *
+   * @param audience The audience of the API.
+   * @param scope Optional scope to clear. If credentials were fetched with a scope, it is recommended to pass the same scope when clearing them.
+   */
+  clearApiCredentials(audience: string, scope?: string): Promise<void>;
+
   /**
    * Clears credentials from secure storage.
    */

src/platforms/native/bridge/NativeBridgeManager.ts

@@ -165,10 +165,11 @@ export class NativeBridgeManager implements INativeBridge {
     );
   }
 
-  clearApiCredentials(audience: string): Promise<void> {
+  clearApiCredentials(audience: string, scope?: string): Promise<void> {
     return this.a0_call(
       Auth0NativeModule.clearApiCredentials.bind(Auth0NativeModule),
-      audience
+      audience,
+      scope
     );
   }