Auth0 ACUL JS SDK Shared Properties

These are the shared Universal Login Context Data Javascript objects available on the global window object for screens using advanced rendering mode.

branding

Retrieve the tenant branding setting details and supports the following values:

Parameter Type Description
hasSettings

boolean.

Are there branding settings configured?
hasThemes

boolean.

Are there theme settings configured?
getSettings()

object. null | BrandingSettings.

Retrieve existing branding settings.
getThemes()

object. null | BrandingThemes

Retrieve existing branding themes.

client

Retrieve the tenant application setting details and supports the following values:

Parameter Type Description
description

null | string.

Retrieve the client's description.
id

string.

Retrieve the client's id.
logoUri

null | string.

Retrieve the URL of the logo for this client.
getMetadata()

object. null | string.

Retrieve the associated metadata of the client.
name

string.

Retrieve the client's name.

organization

Retrieve the tenant organization setting details and supports the following values:

Parameter Type Description
displayName

null | string.

Retrieve the friendly name of the organization.
id

null | string.

Retrieve the organization ID.
name

null | string.

Retrieve the name of the organization.
usage

null | string.

Retrieve the organization usage.
getBranding()

object. null | {

  • colors?:{
    • pageBackground?: string.
    • primary? string.

      • }

  • logoUrl?: string.
 Retrieve the organization's branding settings.
getMetadata()

object. null | string

Retrieve the associated metadata of the organization.

prompt

Retrieve the prompt details for related screens and supports the following value:

Parameter Type Description
name

string.

Retrieve the name of the existing prompt.

screen

Retrieve the current ACUL screen details and supports the following values:

Parameter Type Description
captchaImage

null | string.

Retrieve the captchaImage setting.
captchaProvider

null | string.

Retrieve the captcha provider.
hasCaptcha

boolean.

Is Catpcha enabled?
hasScreenTexts

boolean.

Are there texts associated with the screen?
name

string.

Retrieve the name of the screen.
getCaptchaConfig()

object. null | CaptchaContext.

Retrieve the Captcha configuration.
getScreenData()

object. null | string

Retrieve associated data of the screen.
getScreenLinks()

object. null | string

Retrieve associated links of the screen.
getScreenTexts()

object. null | string

Retrieve associated texts of the screen.

tenant

Retrieve tenant properties and supports the following values:

Parameter Type Description
friendlyName

null | string.

Retrieve the friendly name of the tenant.
name

null | string.

Retrieve the name of the tenant.
getEnabledFactors()

object. null | string[].

Retrieve the tenant multi-factor authentication settings.
getEnabledLocales()

object. null | string[].

Retrieve the tenant supported locale settings.

transaction

Retrieve the current transaction properties and supports the following values:

Parameter Type Description
connectionStrategy

string.

Retrieve the transaction connection strategy.
countryCode

null | string.

Retrieve the transaction country code.
countryPrefix

null | string.

Retrieve the transaction country prefix.
hasAlternateConnections

boolean.

Are there alternate connections configured?
hasCurrentConnection

boolean.

Are there current connections configured?
hasErrors

boolean.

Are there error messages configured?
locale

boolean.

Are there a locales configured?
state

string.

Retrieve the transaction state.
getAlternateConnections()

object. null | (Connection | EnterpriseConnection)[]

Retrieve the transaction alternate connections settings.
getCurrentConnection()

object. Connection

Retrieve the transaction current connection settings.
getErrors()

object. null | Error[]

Retrieve the transaction error settings.

untrustedData

Retrieve data submitted by users from previous screens and supports the following values:

Parameter Type Description
getAuthParams()

object. null | {

    ext: undefined | {

      string.

    };

    loginHint: undefined | string.

    screenHint: undefined | string.

    uiLocales: undefined | string.

    };

Retrieve the auth parameters.
getSubmittedFormData()

object. null | { any }

Retrieve the submitted form data.

user

Retrieve the current user's properties and supports the following values:

Parameter Type Description
email

null | string.

Retrieve the user's email.
id

null | string.

Retrieve the user's ID.
phoneNumber

null | string.

Retrieve the user's phone number.
picture

null | string.

Retrieve the user's picture URL.
username

null | string.

Retrieve the user's username.
getAppMetadata()

object. null | string

Retrieve the associated app_metadata of the user.
getEnrolledFactors()

object. null | string[];

Retrieve the user's multi-factor authentication settings.
getOrganizations()

object. null | {

    branding: undefined | {

      logoUrl: undefined | string.

    };

    displayName: undefined | string.

    organizationId: undefined | string.

    organizationName: undefined | string.

    }[];

Retrieve the user's current oganization memberships.
getUserMetadata()

object. null | string.

Retrieve the associated user_metadata of the user.