MediaWiki-API-hjelp

Dette er en automatisk generert MediaWiki-API-dokumentasjonsside.

Dokumentasjon og eksempler: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

( main | clientlogin )
  • Denne modulen krever skrivetilgang.
  • Denne modulen aksepterer bare POST forespørsler.
  • Kilde: MediaWiki
  • Lisens: GPL-2.0-or-later

Logg inn pa wikien med den interaktive flyten.

Den generelle prosedyren for a bruke denne modulen er:

  1. Hent feltene som er tilgjengelige fra action=query&meta=authmanagerinfo med amirequestsfor=login og en login -nøkkel fra action=query&meta=tokens .
  2. Presenter feltene til brukeren og fa tak i dennes innlevering.
  3. Post til denne modulen med loginreturnurl og relevante felter.
  4. Sjekk status i responsen.
    • Hvis du mottok PASS eller FAIL er du ferdig. Operasjonen lyktes eller mislyktes.
    • Hvis du mottok UI , presenter de nye feltene til brukeren og fa tak i dennes innlevering. Post sa til denne modulen med logincontinue og de relevante feltene satt, og gjenta steg 4.
    • Hvis du mottok REDIRECT , omdiriger brukeren til redirecttarget og vent pa returen til loginreturnurl . Post sa til denne modulen med logincontinue og felter sendt til returnerings-URL-en, og gjenta steg 4.
    • Hvis du mottok RESTART betyr det at autentiseringen virket, men vi ikke har en lenket brukerkonto. Du kan velge a behandle dette som UI eller som FAIL .
Spesifikke parametre:
Andre generelle parametre er tilgjengelige.
loginrequests

Bruk bare disse autentiseringsforespørslene, av id -en returnert fra action=query&meta=authmanagerinfo med amirequestsfor=login eller fra en tidligere respons fra denne modulen.

Separer verdier med | eller alternativ .
Maksimalt antall verdier er 50 (500 for klienter som er tillatt høyere grenser).
loginmessageformat

Format a bruke for returnering av beskjeder.

En av følgende verdier: html, none, raw, wikitext
Standard: wikitext
loginmergerequestfields

Sla sammen feltinformasjon for alle autentiseringsforespørsler til en tabell.

Type: boolsk ( detaljer )
loginpreservestate

Bevar statusen fra et tidligere mislykket innloggingsforsøk hvis det er mulig.

Type: boolsk ( detaljer )
loginreturnurl

Returnerings-URL for tredjeparts autentiseringsflyter, ma være absolutt. Enten denne eller logincontinue kreves.

Nar du mottar en REDIRECT -respons vil du typisk apne en nettleser eller nettvisning til den angitte redirecttarget -URL-en for en tredjeparts autentiseringsflyt. Nar den fullføres vil tredjeparten sende nettleseren eller nettvisningen til denne URL-en. Du bør trekke ut spørrings- eller POST-parametre fra URL-en og sende dem som logincontinue -forespørsler til denne API-modulen.

logincontinue

Denne forespørselen er en fortsettelse etter en tidligere UI - eller REDIRECT -respons. Enten denne eller loginreturnurl er pakrevd.

Type: boolsk ( detaljer )
logintoken

En ≪login≫-nøkkel hentet fra action=query&meta=tokens

Denne parameteren er pakrevd.
*
Denne modulen godtar ekstra parametre avhengig av de tilgjengelige autentiseringsforespørslene. Bruk action=query&meta=authmanagerinfo med amirquestsfor=login (eller en tidligere respons fra denne modulen, hvis det gjelder) for a bestemme hvilke forespørsler som er tilgjengelige og feltene de bruker.
Eksempler:
Start prosessen med a logge inn til wikien som bruker Example med passord ExamplePassword .
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [apne i sandkasse]
Fortsett a logge inn etter en UI -respons for tofaktorautentisering, ved a oppgi en OATHToken pa 987654 .
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [apne i sandkasse]