#Interface: ApiClientLogin

Defined in: core/clientlogin.ts:20

The clientlogin object of an action=clientlogin response.

#Properties

#canpreservestate?

optional canpreservestate?: boolean

Defined in: core/clientlogin.ts:56

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

---

#fields?

optional fields?: Record<string, ApiQueryAuthManagerField>

Defined in: core/clientlogin.ts:53

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

---

#message?

optional message?: ApiAuthManagerMessage

Defined in: core/clientlogin.ts:32

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

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

---

#redirectdata?

optional redirectdata?: Record<string, unknown>

Defined in: core/clientlogin.ts:44

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

URL to continue the flow at. REDIRECT only.

---

#requests?

optional requests?: ApiQueryAuthManagerInfoRequest[]

Defined in: core/clientlogin.ts:47

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

Login outcome.

---

#username?

optional username?: string

Defined in: core/clientlogin.ts:25

Authenticated user name; PASS only.