Interface UserV1

interface UserV1 {
    _expandable?: {
        details?: string;
        operations?: string;
        personalSpace?: string;
    } & {
        [key: string]: unknown;
    };
    _links?: GenericLinks;
    accountId?: null | string;
    accountType?: "" | "atlassian" | "app";
    details?: UserDetails;
    displayName?: null | string;
    email?: null | string;
    externalCollaborator?: boolean;
    isExternalCollaborator?: boolean;
    isGuest?: boolean;
    operations?: null | 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>
    • UserV1

Properties

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

Properties

Optional_expandable

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

Optional_links

_links?: GenericLinks

OptionalaccountId

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.

OptionalaccountType

accountType?: "" | "atlassian" | "app"

The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

Optionaldetails

details?: UserDetails

OptionaldisplayName

displayName?: null | string

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

Optionalemail

email?: null | string

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

OptionalexternalCollaborator

externalCollaborator?: boolean

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

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?: null | OperationCheckResult[]

OptionalpersonalSpace

personalSpace?: null | Space

OptionalprofilePicture

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.

OptionalpublicName

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