> 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: ApiClientLogin

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

The `clientlogin` object of an `action=clientlogin` response.

## Properties

### canpreservestate?

> `optional` **canpreservestate?**: `boolean`

Defined in: [core/clientlogin.ts:56](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L56)

Whether the current AuthManager state can be preserved across requests; `FAIL`/`RESTART` only.

***

### fields?

> `optional` **fields?**: `Record`\<`string`, [`ApiQueryAuthManagerField`](https://types-mediawiki-response.pages.dev/zh/api/core/ApiQueryAuthManagerField.md)>

Defined in: [core/clientlogin.ts:53](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L53)

Field descriptors merged across all `requests`, present only when the
request passed `mergerequestfields`.

***

### message?

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

Defined in: [core/clientlogin.ts:32](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L32)

Failure / interaction message, rendered per the `messageformat` parameter:
a string under `wikitext`/`html`, a `{ key, params }` object under `raw`,
absent under `none`. `FAIL`/`UI`/`RESTART` only.

***

### messagecode?

> `optional` **messagecode?**: `string`

Defined in: [core/clientlogin.ts:35](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L35)

Machine-readable message code accompanying `message`; `FAIL`/`UI`/`RESTART` only.

***

### redirectdata?

> `optional` **redirectdata?**: `Record`\<`string`, `unknown`>

Defined in: [core/clientlogin.ts:44](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L44)

Data for a `REDIRECT` response the client may use to query the remote site
via its API instead of following `redirecttarget`.

***

### redirecttarget?

> `optional` **redirecttarget?**: `string`

Defined in: [core/clientlogin.ts:38](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L38)

URL to continue the flow at. `REDIRECT` only.

***

### requests?

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

Defined in: [core/clientlogin.ts:47](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L47)

AuthManager request descriptors to continue the flow; `UI`/`RESTART`/`REDIRECT` only.

***

### status?

> `optional` **status?**: `string` & `object` | `"PASS"` | `"FAIL"` | `"UI"` | `"REDIRECT"` | `"RESTART"`

Defined in: [core/clientlogin.ts:22](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L22)

Login outcome.

***

### username?

> `optional` **username?**: `string`

Defined in: [core/clientlogin.ts:25](https://github.com/BearBin1215/types-mediawiki-response/blob/c1e25ea2ef2684b43c79e05d6e0dd36e33fbc9a3/src/core/clientlogin.ts#L25)

Authenticated user name; `PASS` only.