Interface User

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 User {
    accountId: string;
    accountType: string;
    active: boolean;
    avatarUrls: Agile.AgileModels.AvatarUrls;
    displayName: string;
    emailAddress: string;
    self: string;
    timeZone: null | string;
}

Properties

accountId accountType active avatarUrls displayName emailAddress self timeZone

Properties

accountId

accountId: string

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

accountType

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)

active

active: boolean

Whether the user is active.

avatarUrls

avatarUrls: Agile.AgileModels.AvatarUrls

displayName

displayName: string

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

emailAddress

emailAddress: string

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

self

self: string

The URL of the user.

timeZone

timeZone: null | 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

Theme

On This Page

accountIdaccountTypeactiveavatarUrlsdisplayNameemailAddressselftimeZone