Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

Use this file to discover all available pages before exploring further.

The CustomizedConsent class implements the customized-consent screen functionality. This screen prompts the user to accept or deny the permissions and authorization details requested by a client application.

​
Constructors

Create an instance of CustomizedConsent screen manager:
Example
import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent';
const customizedConsentManager = new CustomizedConsent();
await customizedConsentManager.accept();

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the customized-consent screen.
​
organization
OrganizationMembers
Provides information about the user’s Organization, such as id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembersOnCustomizedConsent
Contains details specific to the customized-consent screen, including scopes and authorizationDetails.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data for the customized-consent screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during the consent flow.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
accept
Promise<void>
This method submits the user’s decision to accept the requested permissions and authorization details.
Example
import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent';
const customizedConsentManager = new CustomizedConsent();
await customizedConsentManager.accept();
Method Parameters
​
changeLanguage
Promise<void>
This method changes the display language of the Universal Login page.
Example
import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent';
const customizedConsentManager = new CustomizedConsent();
customizedConsentManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
deny
Promise<void>
This method submits the user’s decision to deny the requested permissions and authorization details.
Example
import CustomizedConsent from '@auth0/auth0-acul-js/customized-consent';
const customizedConsentManager = new CustomizedConsent();
await customizedConsentManager.deny();
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.