MediaWiki API súgó

Ez egy automatikusan generált MediaWiki-API-dokumentációs lap.

Dokumentáció és példák: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)

Ez a modul írási jogot igényel.
Ez a modul csak POST kéréseket fogad el.
Forrás: MediaWiki
Licenc: 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

Jellemző paraméterek:

Other general parameters are available.

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.

Az értékékeket a | karakterrel vagy az alternatív elválasztóval válaszd el.

Az értékek maximális száma 50. (500 magasabb korláttal rendelkező ügyfelek számára).

loginmessageformat

Format to use for returning messages.

A következő értékek egyike: html, none, raw, wikitext

Alapértelmezett: wikitext

loginmergerequestfields

Merge field information for all authentication requests into one array.

Típus: logikai (részletek)

loginpreservestate

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

Típus: logikai (részletek)

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.

Típus: logikai (részletek)

logintoken

Egy „login” token, az action=query&meta=tokens kéréssel lekérve

Ez a paraméter kötelező.

*

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.

Példák:

A bejelentkezési folyamat elkezdése Example felhasználónévvel és ExamplePassword jelszóval.: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [megnyitás a homokozóban]
A bejelentkezés folytatása UI válasz után a kétlépcsős azonosításra, az OATHToken paraméternek 987654 értéket megadva.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [megnyitás a homokozóban]