fix(auth): fix the requested_expiry param (v4) (#1174)

Author: guabu

src/auth/backchannel.ts

@@ -88,8 +88,13 @@ export type AuthorizeOptions = {
   audience?: string;
   /**
    * Custom expiry time in seconds for this request.
+   * @deprecated Use {@link AuthorizeOptions.requested_expiry} instead.
    */
   request_expiry?: string;
+  /**
+   * Custom expiry time in seconds for this request.
+   */
+  requested_expiry?: string;
   /**
    * The user ID.
    */
@@ -191,6 +196,12 @@ export class Backchannel extends BaseAuthAPI implements IBackchannel {
       client_id: this.clientId,
     };
 
+    // The correct parameter is `requested_expiry`, but we also accept the deprecated `request_expiry` for backwards compatibility
+    const requestedExpiry = options.requested_expiry || options.request_expiry;
+    if (requestedExpiry) {
+      body.requested_expiry = requestedExpiry;
+    }
+
     await this.addClientAuthentication(body);
 
     const response = await this.request.bind(this)(

test/auth/backchannel.test.ts

@@ -201,6 +201,61 @@ describe('Backchannel', () => {
         interval: 5,
       });
     });
+
+    it('should pass requested_expiry to /bc-authorize', async () => {
+      let receivedRequestedExpiry = 0;
+      nock(`https://${opts.domain}`)
+        .post('/bc-authorize')
+        .reply(201, (uri, requestBody, cb) => {
+          receivedRequestedExpiry = JSON.parse(
+            querystring.parse(requestBody as any)['requested_expiry'] as string
+          );
+          cb(null, {
+            auth_req_id: 'test-auth-req-id',
+            expires_in: 300,
+            interval: 5,
+          });
+        });
+
+      await backchannel.authorize({
+        userId: 'auth0|test-user-id',
+        binding_message: 'Test binding message',
+        scope: 'openid',
+        requested_expiry: '999',
+      });
+
+      expect(receivedRequestedExpiry).toBe(999);
+    });
+
+    it('should pass request_expiry as requested_expiry and retain the request_expiry param for backwards compatibility', async () => {
+      let receivedRequestedExpiry = 0;
+      let receivedRequestExpiry = 0;
+      nock(`https://${opts.domain}`)
+        .post('/bc-authorize')
+        .reply(201, (uri, requestBody, cb) => {
+          receivedRequestedExpiry = JSON.parse(
+            querystring.parse(requestBody as any)['requested_expiry'] as string
+          );
+          receivedRequestExpiry = JSON.parse(
+            querystring.parse(requestBody as any)['request_expiry'] as string
+          );
+          cb(null, {
+            auth_req_id: 'test-auth-req-id',
+            expires_in: 300,
+            interval: 5,
+          });
+        });
+
+      await backchannel.authorize({
+        userId: 'auth0|test-user-id',
+        binding_message: 'Test binding message',
+        scope: 'openid',
+        request_expiry: '999',
+      });
+
+      expect(receivedRequestedExpiry).toBe(999);
+      expect(receivedRequestExpiry).toBe(999);
+    });
   });
 
   describe('#backchannelGrant', () => {