Interface BulkUserLookup

interface BulkUserLookup {
    _expandable: {
        details?: string;
        operations?: string;
        personalSpace?: string;
    } & {
        [key: string]: unknown;
    };
    _links: GenericLinks;
    accountId: null | string;
    accountType: string;
    details?: UserDetails;
    displayName: string;
    email: string;
    isExternalCollaborator?: boolean;
    isGuest?: boolean;
    operations?: OperationCheckResult[];
    personalSpace?: null | Space;
    profilePicture: null | IconV1;
    publicName: string;
    timeZone?: null | string;
    type:
        | "unknown"
        | "user"
        | "known"
        | "anonymous";
    userKey?: null | string;
    username?: null | string;
}

Hierarchy

  • Record<string, unknown>
    • BulkUserLookup

Properties

_expandable _links accountId accountType details? displayName email isExternalCollaborator? isGuest? operations? personalSpace? profilePicture publicName timeZone? type userKey? username?

Properties

_expandable

_expandable: {
    details?: string;
    operations?: string;
    personalSpace?: string;
} & {
    [key: string]: unknown;
}

_links

_links: GenericLinks

accountId

accountId: null | string

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

accountType

accountType: string

The account type of the user, may return empty string if unavailable.

Optionaldetails

details?: UserDetails

displayName

displayName: string

The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

email

email: string

The email address of the user. Depending on the user's privacy setting, this may return an empty string.

OptionalisExternalCollaborator

isExternalCollaborator?: boolean

This is deprecated. Use isGuest instead to find out whether the user is a guest user.

OptionalisGuest

isGuest?: boolean

Whether the user is a guest user

Optionaloperations

operations?: OperationCheckResult[]

OptionalpersonalSpace

personalSpace?: null | Space

profilePicture

profilePicture: null | IconV1

This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

publicName

publicName: string

The public name or nickname of the user. Will always contain a value.

OptionaltimeZone

timeZone?: null | string

This displays user time zone. Depending on the user's privacy setting, this may return null.

type

type:
    | "unknown"
    | "user"
    | "known"
    | "anonymous"

OptionaluserKey

userKey?: null | string

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

Optionalusername

username?: null | string

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

Settings

Member Visibility

On This Page

Properties