Interface GeneralJiraUser

interface GeneralJiraUser {
    accountType: string;
    active?: boolean;
    applicationRoles: unknown;
    avatar?: string;
    avatarUrls?: Record<string, string>;
    displayName: string;
    emailAddress: string;
    exists?: boolean;
    expand: string;
    groups?: {
        items: {
            groupId: string;
            name: string;
        }[];
        size: number;
    };
    imageUrl: string;
    locale: string;
    self: string;
    timeZone: string;
}

Properties

accountType active? applicationRoles avatar? avatarUrls? displayName emailAddress exists? expand groups? imageUrl locale self timeZone

Properties

accountType

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

Valid values: atlassian, app, customer, unknown

Optional active

active?: boolean

Whether the user is active (jira cloud and dc).

applicationRoles

applicationRoles: unknown

The application roles the user is assigned to.

Optional avatar

avatar?: string

Optional avatarUrls

avatarUrls?: Record<string, string>

The avatars of the user.

displayName

displayName: string

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

emailAddress

emailAddress: string

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

Optional exists

exists?: boolean

Whether the user exists (only for dc with TM rest).

expand

expand: string

Expand options that include additional user details in the response.

Optional groups

groups?: {
    items: {
        groupId: string;
        name: string;
    }[];
    size: number;
}

The groups that the user belongs to.

Type declaration

  • items: {
        groupId: string;
        name: string;
    }[]
  • size: number

imageUrl

imageUrl: string

locale

locale: string

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

self

self: string

The URL of the user.
Format: uri

timeZone

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

Theme

On This Page

accountTypeactiveapplicationRolesavataravatarUrlsdisplayNameemailAddressexistsexpandgroupsimageUrllocaleselftimeZone