#Interface: ApiUserInfo

Defined in: core/query/userinfo.ts:35

The userinfo object of a meta=userinfo response.

#Extends

• ApiUserCore

#Properties

#acceptlang?

optional acceptlang?: ApiAcceptLang[]

Defined in: core/query/userinfo.ts:113

Parsed Accept-Language. uiprop=acceptlang.

---

#anon?

optional anon?: true

Defined in: core/query/userinfo.ts:43

true for an anonymous (IP) session. A Flag.

---

#attachedlocal?

optional attachedlocal?: Record<string, boolean>

Defined in: core/query/users.ts:131

Whether the account is attached to each provider, keyed like centralids. usprop=centralids / uiprop=centralids.

#Inherited from

ApiUserCore.attachedlocal

---

#attachedwiki?

optional attachedwiki?: Record<string, boolean>

Defined in: core/query/userinfo.ts:150

Whether the user is attached on the wiki named by the attachedwiki parameter, keyed by provider. Requires uiprop=centralids together with the attachedwiki parameter.

---

#blockanononly?

optional blockanononly?: boolean

Defined in: core/query/users.ts:52

Whether the block only affects anonymous users (soft block). A real boolean.

#Inherited from

ApiUserCore.blockanononly

---

#blockautoblocking?

optional blockautoblocking?: boolean

Defined in: core/query/users.ts:83

Whether the block also enables the autoblock feature. A real boolean.

#Since

MediaWiki 1.46

#Inherited from

ApiUserCore.blockautoblocking

---

#blockcomponents?

optional blockcomponents?: ApiBlockInfo[]

Defined in: core/query/users.ts:76

The individual blocks composing this one; only for composite blocks.

#Since

MediaWiki 1.42

#Inherited from

ApiUserCore.blockcomponents

---

#blockedby?

optional blockedby?: string

Defined in: core/query/users.ts:20

User name of the blocker; '' when unknown (e.g. autoblocks).

#Inherited from

ApiUserCore.blockedby

---

#blockedbyid?

optional blockedbyid?: number

Defined in: core/query/users.ts:23

User id of the blocker; 0 when unknown.

#Inherited from

ApiUserCore.blockedbyid

---

#blockedtimestamp?

optional blockedtimestamp?: string

Defined in: core/query/users.ts:29

When the block was placed or last modified.

#Inherited from

ApiUserCore.blockedtimestamp

---

#blockedtimestampformatted?

optional blockedtimestampformatted?: string

Defined in: core/query/users.ts:34

blockedtimestamp localized for the requesting user.

#Inherited from

ApiUserCore.blockedtimestampformatted

---

#blockemail?

optional blockemail?: boolean

Defined in: core/query/users.ts:59

Whether the block prevents sending email. A real boolean.

#Since

MediaWiki 1.41

#Inherited from

ApiUserCore.blockemail

---

#blockexpiry?

optional blockexpiry?: string

Defined in: core/query/users.ts:37

Block expiry; the literal infinite when the block does not expire.

#Inherited from

ApiUserCore.blockexpiry

---

#blockexpiryformatted?

optional blockexpiryformatted?: string

Defined in: core/query/users.ts:40

blockexpiry localized for the requesting user; only when the block expires.

#Inherited from

ApiUserCore.blockexpiryformatted

---

#blockexpiryrelative?

optional blockexpiryrelative?: string

Defined in: core/query/users.ts:43

Human-readable time to expiry (e.g. in 5 days); only when the block expires.

#Inherited from

ApiUserCore.blockexpiryrelative

---

#blockhidden?

optional blockhidden?: true

Defined in: core/query/users.ts:91

The block itself is suppressed (hidden from users without the hideuser right). A Flag, present only when suppressed.

#Since

MediaWiki 1.47

#Inherited from

ApiUserCore.blockhidden

---

#blockid?

optional blockid?: number

Defined in: core/query/users.ts:17

ID of the block.

#Inherited from

ApiUserCore.blockid

---

#blocknocreate?

optional blocknocreate?: boolean

Defined in: core/query/users.ts:49

Whether the block prevents account creation. A real boolean.

#Inherited from

ApiUserCore.blocknocreate

---

#blockowntalk?

optional blockowntalk?: boolean

Defined in: core/query/users.ts:66

Whether editing one's own talk page is prevented. A real boolean.

#Since

MediaWiki 1.41

#Inherited from

ApiUserCore.blockowntalk

---

#blockpartial?

optional blockpartial?: boolean

Defined in: core/query/users.ts:46

Whether the block only applies to certain pages, namespaces and/or actions. A real boolean.

#Inherited from

ApiUserCore.blockpartial

---

#blockreason?

optional blockreason?: string

Defined in: core/query/users.ts:26

Block reason, in plain text.

#Inherited from

ApiUserCore.blockreason

---

#cancreateaccount?

optional cancreateaccount?: boolean

Defined in: core/query/userinfo.ts:79

Whether the user can create accounts. uiprop=cancreateaccount; a real boolean (false when a policy prevents it), not a Flag.

#Since

MediaWiki 1.40

---

#cancreateaccounterror?

optional cancreateaccounterror?: ApiMessage[] | ApiSpecMessage[]

Defined in: core/query/userinfo.ts:91

Why account creation is not allowed, as message objects. uiprop=cancreateaccount; present only when the cancreateaccount check does not pass.

The shape follows the request's errorformat: under the default (bc) format these are { message, params, code, type } specs, under a modern format they are full ApiMessages.

#Since

MediaWiki 1.40

---

#centralids?

optional centralids?: Record<string, number>

Defined in: core/query/users.ts:128

Global (CentralAuth) ids keyed by provider. usprop=centralids / uiprop=centralids.

#Inherited from

ApiUserCore.centralids

---

#changeablegroups?

optional changeablegroups?: object

Defined in: core/query/userinfo.ts:59

Groups the (current) user may add/remove, and the self-service subsets. uiprop=changeablegroups. Hyphenated keys are literal.

#add?

optional add?: string[]

Groups the user may grant to others.

#add-self?

optional add-self?: string[]

Groups the user may grant to their own account.

#remove?

optional remove?: string[]

Groups the user may revoke from others.

#remove-self?

optional remove-self?: string[]

Groups the user may revoke from their own account.

---

#editcount?

optional editcount?: number

Defined in: core/query/users.ts:113

Total edit count. usprop=editcount / uiprop=editcount.

#Inherited from

ApiUserCore.editcount

---

#email?

optional email?: string

Defined in: core/query/userinfo.ts:140

The user's email address. uiprop=email, and only for a caller with viewmyprivateinfo. An empty string when the address is unset or hidden, otherwise the address.

---

#emailauthenticated?

optional emailauthenticated?: string

Defined in: core/query/userinfo.ts:143

When the email address was confirmed. uiprop=email; absent when never confirmed.

---

#groupmemberships?

optional groupmemberships?: ApiUserGroupMembership[]

Defined in: core/query/users.ts:119

Group memberships with grant/expiry metadata. usprop=groupmemberships / uiprop=groupmemberships.

#Inherited from

ApiUserCore.groupmemberships

---

#groups?

optional groups?: string[]

Defined in: core/query/users.ts:116

Groups the user belongs to (including implicit). usprop=groups / uiprop=groups.

#Inherited from

ApiUserCore.groups

---

#id

id: number

Defined in: core/query/userinfo.ts:37

User id; 0 for anonymous users.

---

#implicitgroups?

optional implicitgroups?: string[]

Defined in: core/query/users.ts:122

Groups that apply by virtue of an inherent right, not membership. usprop=implicitgroups / uiprop=implicitgroups.

#Inherited from

ApiUserCore.implicitgroups

---

#latestcontrib?

optional latestcontrib?: string

Defined in: core/query/userinfo.ts:100

Timestamp of the user's latest edit. uiprop=latestcontrib; absent with no edits.

---

#messages?

optional messages?: boolean

Defined in: core/query/userinfo.ts:53

Whether the user has unread talk-page messages. uiprop=hasmsg; a real boolean.

---

#name

name: string

Defined in: core/query/userinfo.ts:40

User name or IP address.

---

#options?

optional options?: Record<string, string | number | boolean | null>

Defined in: core/query/userinfo.ts:94

The user's preferences map (open; site/user specific). uiprop=options.

---

#ratelimits?

optional ratelimits?: Record<string, Record<string, ApiRateLimit>>

Defined in: core/query/userinfo.ts:103

Effective rate limits keyed by action then bucket. uiprop=ratelimits.

---

#realname?

optional realname?: string

Defined in: core/query/userinfo.ts:133

Real name. uiprop=realname; also absent when $wgHiddenPrefs includes realname.

---

#registrationdate?

optional registrationdate?: string

Defined in: core/query/userinfo.ts:97

Registration timestamp. uiprop=registrationdate.

---

#rights?

optional rights?: string[]

Defined in: core/query/users.ts:125

Effective rights. usprop=rights / uiprop=rights.

#Inherited from

ApiUserCore.rights

---

#systemblocktype?

optional systemblocktype?: string

Defined in: core/query/users.ts:69

Type of the automatically applied system block; only for system blocks.

#Inherited from

ApiUserCore.systemblocktype

---

#temp?

optional temp?: true

Defined in: core/query/userinfo.ts:50

true for a temporary (auto-created) account. A Flag.

#Since

MediaWiki 1.42

---

#theoreticalratelimits?

optional theoreticalratelimits?: Record<string, Record<string, ApiRateLimit>>

Defined in: core/query/userinfo.ts:110

Rate limits that would apply to this user, ignoring the exemptions they actually hold (e.g. noratelimit). Same shape as ratelimits; uiprop=theoreticalratelimits.

---

#unreadcount?

optional unreadcount?: string | number

Defined in: core/query/userinfo.ts:127

Number of unread watchlist notifications; the string 1000+ once the count reaches the cap. uiprop=unreadcount.

---

#watchlistlabels?

optional watchlistlabels?: ApiWatchlistLabel[]

Defined in: core/query/userinfo.ts:121

Custom watchlist exclusion/inclusion labels. uiprop=watchlistlabels; requires $wgEnableWatchlistLabels, and [] when none are set.

#Since

MediaWiki 1.46