Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-fix-auth-api-docs-migration-completion.mintlify.app/llms.txt

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

The Consent class implements the consent screen functionality. This screen presents the requested permissions to the user and collects their decision to accept or deny access.

​
Constructors

Create an instance of Consent screen manager:
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.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 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
ScreenMembersOnConsent
Contains details specific to the consent screen, including the list of scopes being requested and the hideScopes flag.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data for the 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 (grant) the requested permissions.
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.accept();
Method Parameters
​
changeLanguage
Promise<void>
This method changes the display language of the Universal Login page.
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
consentManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
deny
Promise<void>
This method submits the user’s decision to deny (reject) the requested permissions.
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.deny();
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.