> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/llms-full.txt.

# Interface: ApiUser

Defined in: [core/query/users.ts:135](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L135)

A user record. `usprop` controls which fields appear.

## Extends

- [`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md)

## Properties

### attachedlocal?

> `optional` **attachedlocal?**: `Record`\<`string`, `boolean`>

Defined in: [core/query/users.ts:131](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L131)

Whether the account is attached to each provider, keyed like [centralids](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#centralids). `usprop=centralids` / `uiprop=centralids`.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`attachedlocal`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#attachedlocal)

***

### blockanononly?

> `optional` **blockanononly?**: `boolean`

Defined in: [core/query/users.ts:52](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L52)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockanononly`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockanononly)

***

### blockautoblocking?

> `optional` **blockautoblocking?**: `boolean`

Defined in: [core/query/users.ts:83](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L83)

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

#### Since

MediaWiki 1.46

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockautoblocking`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockautoblocking)

***

### blockcomponents?

> `optional` **blockcomponents?**: [`ApiBlockInfo`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiBlockInfo.md)\[]

Defined in: [core/query/users.ts:76](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L76)

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

#### Since

MediaWiki 1.42

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockcomponents`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockcomponents)

***

### blockedby?

> `optional` **blockedby?**: `string`

Defined in: [core/query/users.ts:20](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L20)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockedby`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockedby)

***

### blockedbyid?

> `optional` **blockedbyid?**: `number`

Defined in: [core/query/users.ts:23](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L23)

User id of the blocker; `0` when unknown.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockedbyid`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockedbyid)

***

### blockedtimestamp?

> `optional` **blockedtimestamp?**: `string`

Defined in: [core/query/users.ts:29](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L29)

When the block was placed or last modified.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockedtimestamp`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockedtimestamp)

***

### blockedtimestampformatted?

> `optional` **blockedtimestampformatted?**: `string`

Defined in: [core/query/users.ts:34](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L34)

`blockedtimestamp` localized for the requesting user.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockedtimestampformatted`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockedtimestampformatted)

***

### blockemail?

> `optional` **blockemail?**: `boolean`

Defined in: [core/query/users.ts:59](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L59)

Whether the block prevents sending email. A real `boolean`.

#### Since

MediaWiki 1.41

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockemail`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockemail)

***

### blockexpiry?

> `optional` **blockexpiry?**: `string`

Defined in: [core/query/users.ts:37](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L37)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockexpiry`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockexpiry)

***

### blockexpiryformatted?

> `optional` **blockexpiryformatted?**: `string`

Defined in: [core/query/users.ts:40](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L40)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockexpiryformatted`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockexpiryformatted)

***

### blockexpiryrelative?

> `optional` **blockexpiryrelative?**: `string`

Defined in: [core/query/users.ts:43](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L43)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockexpiryrelative`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockexpiryrelative)

***

### blockhidden?

> `optional` **blockhidden?**: `true`

Defined in: [core/query/users.ts:91](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L91)

The block itself is suppressed (hidden from users without the `hideuser`
right). A [Flag](https://types-mediawiki-response.pages.dev/zh/api/core/Flag.md), present only when suppressed.

#### Since

MediaWiki 1.47

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockhidden`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockhidden)

***

### blockid?

> `optional` **blockid?**: `number`

Defined in: [core/query/users.ts:17](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L17)

ID of the block.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockid`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockid)

***

### blocknocreate?

> `optional` **blocknocreate?**: `boolean`

Defined in: [core/query/users.ts:49](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L49)

Whether the block prevents account creation. A real `boolean`.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blocknocreate`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blocknocreate)

***

### blockowntalk?

> `optional` **blockowntalk?**: `boolean`

Defined in: [core/query/users.ts:66](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L66)

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

#### Since

MediaWiki 1.41

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockowntalk`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockowntalk)

***

### blockpartial?

> `optional` **blockpartial?**: `boolean`

Defined in: [core/query/users.ts:46](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L46)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockpartial`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockpartial)

***

### blockreason?

> `optional` **blockreason?**: `string`

Defined in: [core/query/users.ts:26](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L26)

Block reason, in plain text.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`blockreason`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#blockreason)

***

### cancreate?

> `optional` **cancreate?**: `boolean`

Defined in: [core/query/users.ts:171](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L171)

Whether an account could be created for this name. `usprop=cancreate`; a
real `boolean`, present only on `missing` entries queried by name.

***

### cancreateerror?

> `optional` **cancreateerror?**: [`ApiMessage`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiMessage.md)\[] | [`ApiSpecMessage`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiSpecMessage.md)\[]

Defined in: [core/query/users.ts:177](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L177)

Why [cancreate](#cancreate) is `false` (e.g. a reserved username), shaped per the
request's `errorformat`. Emitted only when the creation check failed.

***

### centralids?

> `optional` **centralids?**: `Record`\<`string`, `number`>

Defined in: [core/query/users.ts:128](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L128)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`centralids`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#centralids)

***

### editcount?

> `optional` **editcount?**: `number`

Defined in: [core/query/users.ts:113](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L113)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`editcount`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#editcount)

***

### emailable?

> `optional` **emailable?**: `boolean`

Defined in: [core/query/users.ts:165](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L165)

Whether the user can be emailed. `usprop=emailable`; a real `boolean`
(`false` when the address is hidden or unconfirmed), not a [Flag](https://types-mediawiki-response.pages.dev/zh/api/core/Flag.md).

***

### gender?

> `optional` **gender?**: `string` & `object` | `"unknown"` | `"male"` | `"female"`

Defined in: [core/query/users.ts:159](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L159)

User gender. `usprop=gender`. Open union for forward compatibility.

***

### groupmemberships?

> `optional` **groupmemberships?**: [`ApiUserGroupMembership`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserGroupMembership.md)\[]

Defined in: [core/query/users.ts:119](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L119)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`groupmemberships`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#groupmemberships)

***

### groups?

> `optional` **groups?**: `string`\[]

Defined in: [core/query/users.ts:116](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L116)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`groups`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#groups)

***

### hidden?

> `optional` **hidden?**: `true`

Defined in: [core/query/users.ts:183](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L183)

The user is hidden (suppressed via a hidden block); a [Flag](https://types-mediawiki-response.pages.dev/zh/api/core/Flag.md).
Emitted regardless of `usprop`.

***

### implicitgroups?

> `optional` **implicitgroups?**: `string`\[]

Defined in: [core/query/users.ts:122](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L122)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`implicitgroups`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#implicitgroups)

***

### missing?

> `optional` **missing?**: `true`

Defined in: [core/query/users.ts:150](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L150)

`true` when no such user exists (`missing` is a [Flag](https://types-mediawiki-response.pages.dev/zh/api/core/Flag.md)).

***

### name?

> `optional` **name?**: `string`

Defined in: [core/query/users.ts:140](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L140)

User name (normalized). Present on found entries and on `missing` entries
queried by name; absent from `missing` entries queried by `ususerids`.

***

### registration?

> `optional` **registration?**: `string` | `null`

Defined in: [core/query/users.ts:156](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L156)

Registration timestamp. `null` for accounts created before registration
timestamps were tracked. `usprop=registration`.

***

### rights?

> `optional` **rights?**: `string`\[]

Defined in: [core/query/users.ts:125](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L125)

Effective rights. `usprop=rights` / `uiprop=rights`.

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`rights`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#rights)

***

### systemblocktype?

> `optional` **systemblocktype?**: `string`

Defined in: [core/query/users.ts:69](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L69)

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

#### Inherited from

[`ApiUserCore`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md).[`systemblocktype`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiUserCore.md#systemblocktype)

***

### systemuser?

> `optional` **systemuser?**: `true`

Defined in: [core/query/users.ts:191](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L191)

`true` when this is a system user (e.g. `MediaWiki default`), absent
otherwise; not gated by any `usprop`. A [Flag](https://types-mediawiki-response.pages.dev/zh/api/core/Flag.md).

#### Since

MediaWiki 1.43

***

### tempexpired?

> `optional` **tempexpired?**: `boolean` | `null`

Defined in: [core/query/users.ts:200](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L200)

Whether a temporary account has expired. `usprop=tempexpired`
(`auprop=tempexpired` for `list=allusers`); a real `boolean` for a
temporary account, and `null` for any other user.

#### Since

MediaWiki 1.46

***

### userid?

> `optional` **userid?**: `number`

Defined in: [core/query/users.ts:147](https://github.com/BearBin1215/types-mediawiki-response/blob/d354a9c689faf74c19e13b617a83dcdb7a83726f/src/core/query/users.ts#L147)

User id. Present on found entries, and on `missing` entries queried by
`ususerids` (echoing the requested id); absent from name-queried `missing`
entries.