Interface User

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.
interface User {
    accountId?: string;
    accountType?:
        | "unknown"
        | "atlassian"
        | "app"
        | "customer";
    active?: boolean;
    applicationRoles?: SimpleListWrapperApplicationRole;
    avatarUrls?: AvatarUrlsBean;
    displayName?: string;
    emailAddress?: string;
    expand?: string;
    groups?: SimpleListWrapperGroupName;
    key?: string;
    locale?: string;
    name?: string;
    self?: string;
    timeZone?: string;
}

Properties

accountId? accountType? active? applicationRoles? avatarUrls? displayName? emailAddress? expand? groups? key? locale? 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. Required in requests.

OptionalaccountType

accountType?:
    | "unknown"
    | "atlassian"
    | "app"
    | "customer"

The user account type. Can take the following values:

  • atlassian regular Atlassian user account
  • app system account used for Connect applications and OAuth to represent external systems
  • customer Jira Service Desk account representing an external service desk

Optionalactive

active?: boolean

Whether the user is active.

OptionalapplicationRoles

applicationRoles?: SimpleListWrapperApplicationRole

The application roles the user is assigned to.

OptionalavatarUrls

avatarUrls?: AvatarUrlsBean

The avatars of the user.

OptionaldisplayName

displayName?: string

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

OptionalemailAddress

emailAddress?: string

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

Optionalexpand

expand?: string

Expand options that include additional user details in the response.

Optionalgroups

groups?: SimpleListWrapperGroupName

The groups that the user belongs to.

Optionalkey

key?: string

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

Optionallocale

locale?: string

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

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. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

Settings

Member Visibility

On This Page

Properties