MediaWiki API 帮助
这是自动生成的MediaWiki API文档页面。
文档和例子:-{R|https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page}-
action=clientlogin (login)
(main | clientlogin)
- 此模块需要写入权限。
- 此模块只允许POST请求。
- 来源:MediaWiki
- 许可协议:GPL-2.0-or-later
使用交互式流登录wiki。
使用此模块的一般程序是:
- 通过amirequestsfor=login取得来自action=query&meta=authmanagerinfo的可用字段,和来自action=query&meta=tokens的login令牌。
- 向用户显示字段,并获得其提交的内容。
- 发送(POST)至此模块,提供loginreturnurl及任何相关字段。
- 在响应中检查status。
- 如果您收到了PASS(成功)或FAIL(失败),则认为操作结束。成功与否如上句所示。
- 如果您收到了UI,向用户显示新字段,并再次获取其提交的内容。然后再次使用logincontinue,向本模块提交相关字段,并重复第四步。
- 如果您收到了REDIRECT,将用户指向redirecttarget中的目标,等待其返回loginreturnurl。然后再次使用logincontinue,向本模块提交返回URL中提供的一切字段,并重复第四步。
- 如果您收到了RESTART,这意味着身份验证正常运作,但我们没有链接的用户账户。您可以将此看做UI或FAIL。
具体参数:
其他通用参数可用。
- loginrequests
只使用这些身份验证请求,通过返回自action=query&meta=authmanagerinfo的id与amirequestsfor=login,或来自此模块之前的响应。
- 通过|或替代物隔开各值。
- 值的最大值为50(允许更高上限的客户端为500)。
- loginmessageformat
用于返回消息的格式。
- 以下值中的一个:html、none、raw、wikitext
- 默认:wikitext
- loginmergerequestfields
合并用于所有身份验证请求的字段信息至一个数组中。
- 类型:布尔型 (详情)
- loginpreservestate
从之前失败的登录尝试中保持状态,如果可能。
- 类型:布尔型 (详情)
- loginreturnurl
为第三方身份验证流返回URL,必须为绝对值。需要此值或logincontinue两者之一。
在接收REDIRECT响应时,您将代表性的打开浏览器或web视图到特定用于第三方身份验证流的redirecttarget URL。当它完成时,第三方将发生浏览器或web视图至此URL。您应当提取任何来自URL的查询或POST参数,并作为logincontinue请求传递至此API模块。
- logincontinue
此请求是在早先的UI或REDIRECT响应之后的附加请求。必填此值或loginreturnurl。
- 类型:布尔型 (详情)
- logintoken
从action=query&meta=tokens取回的“login”令牌
- 这个参数是必需的。
- *
- 此模块允许额外参数,取决于可用的身份验证请求。使用action=query&meta=authmanagerinfo与amirequestsfor=login(或之前来自此模块的相应,如果可以)以决定可用请求及其使用的字段。
例子:
- 开始作为用户Example和密码ExamplePassword登录至wiki的过程。
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [在沙盒中打开]
- 在UI响应双因素验证后继续登录,补充OATHToken 987654。
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [在沙盒中打开]