MediaWiki API 帮助

这是自动生成的MediaWiki API文档页面。

文档和例子:-{R|https://www.mediawiki.org/wiki/API:Main_page/zh}-

action=clientlogin (login)

main | clientlogin
  • 此模块只允许POST请求。
  • 来源:MediaWiki
  • 许可协议:GPL-2.0-or-later

使用交互式流登录wiki。

使用此模块的一般程序是:

  1. 通过amirequestsfor=login取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokenslogin令牌。
  2. 向用户显示字段,并获得其提交的内容。
  3. 发送(POST)至此模块,提供loginreturnurl及任何相关字段。
  4. 在响应中检查status
    • 如果您收到了PASS(成功)或FAIL(失败),则认为操作结束。成功与否如上句所示。
    • 如果您收到了UI,向用户显示新字段,并再次获取其提交的内容。然后再次使用logincontinue,向本模块提交相关字段,并重复第四步。
    • 如果您收到了REDIRECT,将用户指向redirecttarget中的目标,等待其返回loginreturnurl。然后再次使用logincontinue,向本模块提交返回URL中提供的一切字段,并重复第四步。
    • 如果您收到了RESTART,这意味着身份验证正常运作,但我们没有链接的用户账户。您可以将此看做UIFAIL
参数:
loginrequests

只使用这些身份验证请求,通过返回自action=query&meta=authmanagerinfoidamirequestsfor=login,或来自此模块之前的响应。

通过|替代物隔开各值。
Maximum number of values is 50 (500 for clients allowed higher limits).
loginmessageformat

用于返回消息的格式。

以下值中的一个:html、none、raw、wikitext
Default: wikitext
loginmergerequestfields

合并用于所有身份验证请求的字段信息至一个数组中。

Type: boolean (details)
loginpreservestate

从之前失败的登录尝试中保持状态,如果可能。

Type: boolean (details)
loginreturnurl

为第三方身份验证流返回URL,必须为绝对值。需要此值或logincontinue两者之一。

在接收REDIRECT响应时,您将代表性的打开浏览器或web视图到特定用于第三方身份验证流的redirecttarget URL。当它完成时,第三方将发生浏览器或web视图至此URL。您应当提取任何来自URL的查询或POST参数,并作为logincontinue请求传递至此API模块。

logincontinue

此请求是在早先的UIREDIRECT响应之后的附加请求。必需此值或loginreturnurl

Type: boolean (details)
logintoken

action=query&meta=tokens取回的“login”令牌

This parameter is required.
*
此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfoamirequestsfor=login(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。