Skip to content

Variable: UserSchema ​

ts
const UserSchema: ZodObject<{
  accountId: ZodOptional<ZodString>;
  accountType: ZodOptional<ZodCustom<"unknown" | string & object | "atlassian" | "app" | "customer", "unknown" | string & object | "atlassian" | "app" | "customer">>;
  active: ZodOptional<ZodBoolean>;
  applicationRoles: ZodOptional<ZodObject<{
     callback: ZodOptional<ZodObject<{
     }, ApiObjectConfig<undefined>>>;
     items: ZodOptional<ZodArray<ZodObject<{
        defaultGroups: ZodOptional<ZodArray<...>>;
        defaultGroupsDetails: ZodOptional<ZodArray<...>>;
        defined: ZodOptional<ZodBoolean>;
        groupDetails: ZodOptional<ZodArray<...>>;
        groups: ZodOptional<ZodArray<...>>;
        hasUnlimitedSeats: ZodOptional<ZodBoolean>;
        key: ZodOptional<ZodString>;
        name: ZodOptional<ZodString>;
        numberOfSeats: ZodOptional<ZodNumber>;
        platform: ZodOptional<ZodBoolean>;
        remainingSeats: ZodOptional<ZodNumber>;
        selectedByDefault: ZodOptional<ZodBoolean>;
        userCount: ZodOptional<ZodNumber>;
        userCountDescription: ZodOptional<ZodString>;
     }, ApiObjectConfig<undefined>>>>;
     max-results: ZodOptional<ZodNumber>;
     pagingCallback: ZodOptional<ZodObject<{
     }, ApiObjectConfig<undefined>>>;
     size: ZodOptional<ZodNumber>;
  }, ApiObjectConfig<undefined>>>;
  appType: ZodOptional<ZodString>;
  avatarUrls: ZodOptional<ZodObject<{
     16x16: ZodOptional<ZodURL>;
     24x24: ZodOptional<ZodURL>;
     32x32: ZodOptional<ZodURL>;
     48x48: ZodOptional<ZodURL>;
  }, ApiObjectConfig<undefined>>>;
  displayName: ZodOptional<ZodString>;
  emailAddress: ZodOptional<ZodNullable<ZodString>>;
  expand: ZodOptional<ZodString>;
  groups: ZodOptional<ZodObject<{
     callback: ZodOptional<ZodObject<{
     }, ApiObjectConfig<undefined>>>;
     items: ZodOptional<ZodArray<ZodObject<{
        groupId: ZodOptional<ZodNullable<...>>;
        name: ZodOptional<ZodString>;
        self: ZodOptional<ZodURL>;
     }, ApiObjectConfig<undefined>>>>;
     max-results: ZodOptional<ZodNumber>;
     pagingCallback: ZodOptional<ZodObject<{
     }, ApiObjectConfig<undefined>>>;
     size: ZodOptional<ZodNumber>;
  }, ApiObjectConfig<undefined>>>;
  guest: ZodOptional<ZodBoolean>;
  locale: ZodOptional<ZodNullable<ZodString>>;
  self: ZodOptional<ZodURL>;
  timeZone: ZodOptional<ZodString>;
}, ApiObjectConfig<undefined>>;

Defined in: src/cloud/models/user.ts:19

A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:

  • User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, displayName provides an indication and other parameters have default values or are blank (for example, email is blank).
  • User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, accountId returns unknown and all other parameters have fallback values.
  • User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.