Jira.js - Jira Cloud API library
    Preparing search index...

    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?: string;
        active: boolean;
        applicationRoles?: Version3Models.SimpleListWrapperApplicationRole;
        avatarUrls?: Version3Models.AvatarUrls;
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: Version3Models.SimpleListWrapperGroupName;
        key?: string;
        locale?: string;
        name?: string;
        self?: string;
        timeZone?: string;
    }
    Index

    Properties

    accountId accountType? active applicationRoles? avatarUrls? displayName? emailAddress? expand? groups? key? locale? name? self? timeZone?

    Properties

    accountId: string

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

    accountType?: string

    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

    active: boolean

    Whether the user is active.

    applicationRoles?: Version3Models.SimpleListWrapperApplicationRole
    avatarUrls?: Version3Models.AvatarUrls
    displayName?: string

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

    emailAddress?: string

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

    expand?: string

    Expand options that include additional user details in the response.

    groups?: Version3Models.SimpleListWrapperGroupName
    key?: string

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

    locale?: string

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

    name?: string

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

    self?: string

    The URL of the user.

    timeZone?: string

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

    Settings

    Member Visibility

    On This Page

    Properties