Interface UserDetails

User details 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.
interface UserDetails {
    accountId?: string;
    accountType?: string;
    active?: boolean;
    avatarUrls?: UserBeanAvatarUrls;
    displayName?: string;
    emailAddress?: string;
    key?: string;
    name?: string;
    self?: string;
    timeZone?: string;
}

Properties

accountId? accountType? active? avatarUrls? displayName? emailAddress? key? name? self? timeZone?

Properties

OptionalaccountId

accountId?: string

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

OptionalaccountType

accountType?: string

The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

Optionalactive

active?: boolean

Whether the user is active.

OptionalavatarUrls

avatarUrls?: UserBeanAvatarUrls

The avatars of the user.

OptionaldisplayName

displayName?: string

The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

OptionalemailAddress

emailAddress?: string

The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

Optionalkey

key?: string

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

Optionalname

name?: string

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

Optionalself

self?: string

The URL of the user.

OptionaltimeZone

timeZone?: string

The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

Settings

Member Visibility

On This Page

Properties