Interface: User

Defined in: src/v1/models/user.ts:12

Indexable

[key: string]: unknown

Properties

_expandable?

optional _expandable?: object;

Defined in: src/v1/models/user.ts:40

details?

optional details?: string;

operations?

optional operations?: string;

personalSpace?

optional personalSpace?: string;

---

_links?

optional _links?: object;

Defined in: src/v1/models/user.ts:45

Index Signature

[key: string]: unknown

base?

optional base?: string;

Base URL of the Confluence site.

byOperation?

optional byOperation?: string;

Link to the restrictions grouped by operation.

collection?

optional collection?: string;

Link to the collection this entity belongs to.

context?

optional context?: string;

Context path of the Confluence site.

download?

optional download?: string;

Download link for the content.

editui?

optional editui?: string;

Edit UI link of the content.

edituiv2?

optional edituiv2?: string;

Edit UI (v2 editor) link of the content.

next?

optional next?: string;

Relative URL of the next page of results.

prev?

optional prev?: string;

Relative URL of the previous page of results.

self?

optional self?: string;

Canonical link to this entity.

tinyui?

optional tinyui?: string;

Short web UI link of the content.

webui?

optional webui?: string;

Web UI link of the content.

---

accountId?

optional accountId?: string | null;

Defined in: src/v1/models/user.ts:16

---

accountStatus?

optional accountStatus?: string;

Defined in: src/v1/models/user.ts:46

---

accountType?

optional accountType?: "" | string & object | "atlassian" | "app";

Defined in: src/v1/models/user.ts:21

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.

---

details?

optional details?: object;

Defined in: src/v1/models/user.ts:38

Index Signature

[key: string]: unknown

business?

optional business?: object;

Index Signature

[key: string]: unknown

business.department?

optional department?: string;

This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details.

business.location?

optional location?: string;

This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details.

business.position?

optional position?: string;

This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details.

personal?

optional personal?: object;

Index Signature

[key: string]: unknown

personal.email?

optional email?: string;

This property has been deprecated due to privacy changes. Use the User.email property instead. See the migration guide for details.

personal.im?

optional im?: string;

This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details.

personal.phone?

optional phone?: string;

This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details.

personal.website?

optional website?: string;

This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details.

---

displayName?

optional displayName?: string | null;

Defined in: src/v1/models/user.ts:28

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

---

email?

optional email?: string | null;

Defined in: src/v1/models/user.ts:23

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

---

externalCollaborator?

optional externalCollaborator?: boolean;

Defined in: src/v1/models/user.ts:32

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

---

isExternalCollaborator?

optional isExternalCollaborator?: boolean;

Defined in: src/v1/models/user.ts:34

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

---

isGuest?

optional isGuest?: boolean;

Defined in: src/v1/models/user.ts:36

Whether the user is a guest user

---

locale?

optional locale?: string;

Defined in: src/v1/models/user.ts:47

---

operations?

optional operations?: object[] | null;

Defined in: src/v1/models/user.ts:37

---

personalSpace?

optional personalSpace?: Space;

Defined in: src/v1/models/user.ts:39

---

profilePicture?

optional profilePicture?: object;

Defined in: src/v1/models/user.ts:26

Index Signature

[key: string]: unknown

height

height: number;

isDefault

isDefault: boolean;

path

path: string;

width

width: number;

---

publicName?

optional publicName?: string;

Defined in: src/v1/models/user.ts:25

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

---

timeZone?

optional timeZone?: string | null;

Defined in: src/v1/models/user.ts:30

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

---

type

type: "unknown" | "user" | string & object | "known" | "anonymous";

Defined in: src/v1/models/user.ts:13

---

userKey?

optional userKey?: string | null;

Defined in: src/v1/models/user.ts:15

---

username?

optional username?: string | null;

Defined in: src/v1/models/user.ts:14