Skip to main content
ConsentMembers
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
const handleAccept = async () => {
 try {
   await consentManager.accept();
   console.log('Consent accepted successfully.');
 } catch (err) {
   console.error('Error accepting consent:', err);
 }
};

​
Constructors

​
Consent
Constructor
Creates an instance of the Consent screen manager. The constructor initializes the BaseContext and sets up the screen property with an instance of ScreenOverride tailored for the consent screen.

​
Throws

If the Universal Login Context is not available or if the current screen name in the context does not match Consent.screenIdentifier.

​
Properties

​
branding
​
client
​
organization
​
prompt
​
screen
Holds the specific screen data and properties for the Consent screen, processed by ScreenOverride. This includes the list of scopes being requested and the hideScopes flag.
​
tenant
​
transaction
​
untrustedData
​
user
​
screenIdentifier
string

​
Methods

​
accept
Promise<void>
Submits the user’s decision to accept (grant) the requested permissions. This method prepares and posts form data to the /u/consent?state=<transaction_state> endpoint with action: "accept". The transaction state is automatically included in both the URL query parameter and the form body.A promise that resolves once the form submission is initiated. Typically, a successful submission leads to a server-side redirect.

​
Throws

Throws an error if FormHandler encounters an unrecoverable issue during submission (e.g., network error). Server-side validation errors from Auth0 (like “invalid_request”) are not thrown as JavaScript errors but are made available in this.transaction.errors after the operation.
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
const handleAccept = async () => {
 try {
   await consentManager.accept();
   console.log('Consent accepted successfully.');
 } catch (err) {
   console.error('Error accepting consent:', err);
 }
};
​
deny
Promise<void>
Submits the user’s decision to deny (reject) the requested permissions. This method prepares and posts form data to the /u/consent?state=<transaction_state> endpoint with action: "deny". The transaction state is automatically included in both the URL query parameter and the form body.A promise that resolves once the form submission is initiated. A successful submission usually results in a server-side redirect.

​
Throws

Throws an error if FormHandler encounters an issue (e.g., network error). Server-side validation errors are reflected in this.transaction.errors.
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
const handleDeny = async () => {
 try {
   await consentManager.deny();
   console.log('Form denied successfully.');
 } catch (err) {
   console.error('Failed to deny form:', error);
 }
};
​
getErrors
Retrieves the array of transaction errors from the context, or an empty array if none exist.An array of error objects from the transaction context.