addOnUISdk.app.currentUser

Provides access to the current user's identity, premium status, and guest-state checks in Adobe Express. See the Identify Users Guide for common use cases and examples.

data-slots=text

data-variant=info
Runtime: This API runs in the iframe runtime (addOnUISdk). See the Add-on Architecture Guide for the dual-runtime model.

Methods

identity()

Returns the user's canonical ID and any legacy IDs associated with the current profile. All IDs are SHA-256 hashed and cannot be used to identify users personally. Use this method for use cases that rely on user identification, such as subscription management, analytics, and account linking.

Signature

identity(): Promise<UserIdentity>

Return Value

A Promise that resolves to a UserIdentity object.

UserIdentity
Property
Type
Description
userId
string
SHA-256 hashed, canonical ID for the current active profile. Matches the value returned by the deprecated userId() method for accounts that haven't been consolidated through Connected Enterprise.
legacyIds
string[]
SHA-256 hashed legacy user IDs, if any.

Example Usage

data-slots=heading, code

data-repeat=2

JavaScript

import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";

addOnUISdk.ready.then(async () => {
  const identity = await addOnUISdk.app.currentUser.identity();
  console.log("User ID: " + identity.userId);

  if (identity.legacyIds.length > 0) {
    console.log("Legacy IDs: " + identity.legacyIds.join(", "));
  }
});

Output

User ID: 882ee4e7487236f35cd593f60e595892ace578ba7c5d5027a4b2cec196aa4ced
Legacy IDs: a3f1c2d4e5b6789012345678abcdef90abcdef90abcdef90abcdef90abcdef90, b7e8d9f0a1c2345678901234cdef5678cdef5678cdef5678cdef5678cdef5678

userId()

data-slots=text

data-variant=warning
Deprecated. userId() is scheduled for removal on November 15, 2026 in favor of the identity() method. After that date, this method will throw an error. Calling this method now logs a one-time console warning.

Retrieve a SHA-256 hashed ID for the current user of the host application (Adobe Express).

Signature

userId(): Promise<string>

Return Value

A resolved Promise containing the userId of the current user.

Example Usage

data-slots=heading, code

data-repeat=2

JavaScript

import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";

addOnUISdk.ready.then(async () => {
  const userId = await addOnUISdk.app.currentUser.userId();
  console.log("User ID: " + userId);
});

Output

User ID: 3cda976828a4a90d13b0f38b1f8a59b1d6845cccfc48037fb30bb75d3ef67d36

isPremiumUser()

Indicates whether the current user has an Adobe Express premium subscription.

Signature

isPremiumUser(): Promise<boolean>

Return Value

A resolved Promise containing a boolean value indicating if the user is a premium user or not.

Example Usage

import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";

addOnUISdk.ready.then(async () => {
  const isPremiumUser = await addOnUISdk.app.currentUser.isPremiumUser();
  if (!isPremiumUser) {
    // User is not premium; show only free-tier features.
  }
});

isAnonymousUser()

Determines whether the current user is browsing as a guest (not signed in).

Signature

isAnonymousUser(): Promise<boolean>

Return Value

Returns a Promise that resolves to a boolean indicating whether the user is anonymous.

Example Usage

import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js";

addOnUISdk.ready.then(async () => {
  const isAnonymousUser = await addOnUISdk.app.currentUser.isAnonymousUser();
  if (isAnonymousUser) {
    // User is not logged in; show guest-level features only.
    console.log("User is anonymous, some features may be limited.");
  } else {
    // User is logged in; show full features.
    console.log("User is logged in.");
  }
});