@auth0/auth0-acul-js - v0.1.0-beta.7
    Preparing search index...

    Interface ConsentMembers

    ConsentMembers

    Hierarchy

    • BaseMembers
      • ConsentMembers

    Implemented by

    Index

    Properties

    Provides access to the specific properties and data of the Consent screen, including the list of scopes being requested and the hideScopes flag.

    Methods

    • Submits the user's decision to accept (grant) the requested permissions. This action posts to the /u/consent endpoint with action: "accept".

      Parameters

      • Optionalpayload: Classes.CustomOptions

        Optional. An object for any custom key-value pairs to be sent with the request. These parameters will be included in the form data submitted to the server.

      Returns Promise<void>

      A promise that resolves when the accept action is successfully submitted. On success, Auth0 typically redirects the user back to the application or to the next step in the authentication flow.

      Throws an error if the form submission fails (e.g., network issue, invalid state). Server-side errors (like "invalid_request") will be reflected in this.transaction.errors after the operation, rather than being thrown as JavaScript errors.

      // Assuming 'consentManager' is an instance of the Consent screen SDK class
      try {
      await consentManager.accept();
      // If successful, the page will typically redirect.
      } catch (error) {
      // Handle unexpected errors during the submission itself.
      console.error("Failed to submit consent acceptance:", error);
      }
      // After the await, check consentManager.transaction.errors for server-side validation issues.
    • Submits the user's decision to deny (reject) the requested permissions. This action posts to the /u/consent endpoint with action: "deny".

      Parameters

      • Optionalpayload: Classes.CustomOptions

        Optional. An object for any custom key-value pairs to be sent with the request. These parameters will be included in the form data submitted to the server.

      Returns Promise<void>

      A promise that resolves when the deny action is successfully submitted. On success, Auth0 typically redirects the user, potentially showing an access denied message or returning an error to the application.

      Throws an error if the form submission fails (e.g., network issue, invalid state). Server-side errors are reflected in this.transaction.errors.

      // Assuming 'consentManager' is an instance of the Consent screen SDK class
      try {
      await consentManager.deny({ reason: "user_declined" }); // Example custom option
      // If successful, the page will typically redirect.
      } catch (error) {
      console.error("Failed to submit consent denial:", error);
      }
      // After the await, check consentManager.transaction.errors for server-side validation issues.