MediaWiki-API-Hilfe

Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.

Dokumentation und Beispiele: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)

Dieses Modul akzeptiert nur POST-Anfragen.
Quelle: MediaWiki
Lizenz: GPL-2.0-or-later

Log in to the wiki using the interactive flow.

The general procedure to use this module is:

Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=login, and a login token from action=query&meta=tokens.
Present the fields to the user, and obtain their submission.
Post to this module, supplying loginreturnurl and any relevant fields.
Check the status in the response.
- If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
- If you received UI, present the new fields to the user and obtain their submission. Then post to this module with logincontinue and the relevant fields set, and repeat step 4.
- If you received REDIRECT, direct the user to the redirecttarget and wait for the return to loginreturnurl. Then post to this module with logincontinue and any fields passed to the return URL, and repeat step 4.
- If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login

Parameter:

loginrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.

Werte mit | trennen oder Alternative.

Die maximale Anzahl von Werten beträgt 50 (500 für Clients, die höhere Limits erlauben).

loginmessageformat

Zu verwendendes Format zur Rückgabe von Nachrichten.

Einer der folgenden Werte: html, none, raw, wikitext

Standard: wikitext

loginmergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)

loginpreservestate

Preserve state from a previous failed login attempt, if possible.

Type: boolean (details)

loginreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a logincontinue request to this API module.

logincontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or loginreturnurl is required.

Type: boolean (details)

logintoken

Ein „login“-Token abgerufen von action=query&meta=tokens

Dieser Parameter ist erforderlich.

*

This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=login (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

Beispiele:

Startet den Prozess der Anmeldung in dem Wiki als Benutzer Example mit dem Passwort ExamplePassword.: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [in Spielwiese öffnen]
Continue logging in after a UI response for two-factor auth, supplying an OATHToken of 987654.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [in Spielwiese öffnen]